Customer support
Chatwoot in your product and your AI agents, through one API
The Chatwoot toolkit covers conversations, messages, contacts, inboxes, agents and teams of a Chatwoot Cloud account: start and assign conversations, change their status and labels, send messages or internal notes, and manage contacts. Through Connect, your product or AI agent calls these operations with one endpoint, while Connect stores the credentials and logs every execution.
15 days to try it. No credit card.
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>"
}
}How it works
From a connected customer to the first Chatwoot call.
- 1
Your customer connects the account
Your system opens a Connect session for the toolkit and your customer connects their Chatwoot account. You get the connection id.
- 2
Your product calls the tool
A POST to /api/tools/{tool}/execute with the connection id and arguments. On success, Connect preserves the app's response status and body.
- 3
Connect handles the rest
It stores the credential encrypted, renews tokens for OAuth connections that support renewal and records executions in an audit trail available through the API.
Use cases
What your product does with Chatwoot.
Open a conversation from your app
When a user needs help, find or create the contact, then create a conversation in the right inbox with a first message.
AI agent triage
An agent reads the latest messages of a conversation, replies or leaves a private note, then labels, assigns it to an agent or team, and sets its status.
Keep contacts in sync
Search contacts by email or phone and update their fields when the customer record changes in your CRM or SaaS.
Tools
15 Chatwoot tools
- List conversationsGETLists conversations of an account, the open ones by default, with status, labels, inbox_id, can_reply, the contact in meta.sender, the assignee and the last message. data.meta has the counts by assignee type. Pages are numbered from 1; an empty payload means there are no more pages.
- Create conversationPOSTStarts 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.
- Update conversation statusPOSTSets the status of a conversation: open, resolved, pending or snoozed. Without snoozed_until a snoozed conversation waits for the next reply of the contact, and any reply of the contact reopens it.
- Assign conversationPOSTAssigns a conversation to an agent or to a team. When assignee_id is sent, team_id is ignored.
- Update conversation labelsPOSTSets the labels of a conversation. The list sent replaces the current labels, so it must include the ones to keep.
- List messagesGETReturns the latest messages of a conversation in ascending order, with meta holding its labels, contact and assignee. sender_type says who sent each message, and private marks internal notes. For older messages, pass before with the id of the oldest one received.
- Create messagePOSTSends a message in a conversation. An outgoing message goes to the contact through the channel of the inbox, such as WhatsApp, email or the website widget; private true makes it an internal note only agents see. On WhatsApp, template_params sends an approved template.
- Search contactsGETSearches the contacts that have an identifier, email or phone, by name, identifier, email or phone number, 15 per page. Each contact has contact_inboxes, pairing each inbox with the source_id that Create conversation needs. meta.count is the total; a page with fewer than 15 contacts is the last one.
- Create contactPOSTCreates a contact in an inbox of the account. The response brings the contact and the contact_inbox with the source_id that Create conversation needs.
- Update contactPUTUpdates a contact: send only the fields to change.
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.
Questions about the Chatwoot toolkit
Do I need to build against the Chatwoot API?
No. Connect ships 15 Chatwoot tools, described and ready. Your customer connects the account and your system calls every tool through the same endpoint, with the same request format.
How does my customer connect their Chatwoot account?
With the mode the toolkit accepts: API key. Connect stores the credential encrypted and never returns it to your system.
Does it work with AI agents?
Yes. Each tool's input is described in JSON Schema, which your agent uses directly as a tool definition. The agent picks the tool and the arguments, and your system makes the call to Connect.
Does my customer need a Reportei account?
No. Your customer connects the account on a Connect screen, or your system sends the credential through the API, and they keep using only your product.
Toolkits in the same category
See all 100 toolkitsSee Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
