Create conversation with the Chatwoot API

Starts a conversation with a contact in an inbox, optionally with a first message. source_id identifies the contact in that inbox: it comes from contact_inboxes of Search contacts, from Create contact or from Create contact inbox. On WhatsApp inboxes, the first message goes as an approved template in message.template_params.

Identifier
chatwoot_create_conversation

The request

POST https://connect.reportei.com/api/tools/chatwoot_create_conversation/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "account_id": 1,
    "source_id": "<source_id>"
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
account_idintegerYesId of the Chatwoot account: the id of one of the accounts from Get profile, also shown in the dashboard URL after /accounts/, as in app.chatwoot.com/app/accounts/123.
source_idstringYessource_id of the contact in the inbox, from contact_inboxes of Search contacts, Create contact or Create contact inbox. Each item pairs an inbox with its source_id.
inbox_idintegerNoInbox of the conversation, the same of the source_id, from List inboxes.
contact_idintegerNoId of the contact, from Search contacts.
statusstringNoInitial status of the conversation.Values: open, resolved, pending
assignee_idintegerNoId of the agent to assign, from List agents.
team_idintegerNoId of the team to assign, from List teams.
custom_attributesobjectNoConversation custom attribute values keyed by attribute key.
messageobjectNoFirst message of the conversation, sent to the contact.

Supported connections

Your customer connects their Chatwoot account once, with one of the modes below. The same connection serves every tool of the toolkit.

API key

Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/chatwoot_create_conversation. It becomes your agent's tool definition with no conversion.

Other Chatwoot tools

See all 15 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.