Skip to main content
POST
Connect Chatwoot

Authorizations

x-api-key
string
header
required

Your ps_ API key

Headers

x-whatsapp-number-id
string

Scopes to a single number (required for tenant keys / per-number OAuth grants).

Body

application/json
instanceUrl
string
required

Base URL of the Chatwoot instance.

Example:

"https://app.chatwoot.com"

accountId
string
required

Chatwoot account id (numeric string).

Example:

"1"

userAccessToken
string
required

Chatwoot user access token (agent/admin api_access_token).

Example:

"cw_xxx"

channelMode
enum<string>

Channel preference: auto (default), api (force mirror inbox), native (force whatsapp_cloud inbox when eligible).

Available options:
auto,
api,
native
Example:

"auto"

Response

Chatwoot integration status