chatwoot

name

chatwoot

description

Use the official Chatwoot CLI to inspect and operate Chatwoot conversations, messages, contacts, inboxes, labels, teams, help center articles, webhooks, reports, and raw Application API paths. Use when Codex needs to call Chatwoot APIs, work with a self-hosted Chatwoot domain, fetch customer feedback, summarize recent conversations, send replies or private notes, assign/label/close conversations, or guide a user through installing and authenticating the Chatwoot CLI.

Chatwoot

Rule

Use the official chatwoot CLI. If the CLI is missing or unauthenticated, stop and guide the user through install/auth first.

Do not bypass the CLI with raw REST calls, Rails runner, database queries, or server-side container access unless the user explicitly asks for a fallback path after seeing the install/auth instructions. Boss picked the CLI route; respect it.

For self-hosted deployments, prompt for or discover:

• Base URL: the Chatwoot instance URL, for example https://chatwoot.example.com
• Account ID: the numeric account ID from the Chatwoot dashboard URL or chatwoot auth status

Never store or print the API access token in skill files, docs, shell history examples, or final answers.

Setup Check

1. Check whether the CLI exists:

command -v chatwoot && chatwoot --version

2. If missing, guide the user to install:

curl -fsSL https://chwt.app/install-cli | sh

After install, ask the user to restart the shell if chatwoot is still not found, then run:

chatwoot --version
chatwoot auth login

3. Authenticate:

chatwoot auth login