Description
The Chatwoot handover provider bridges Cognigy and Chatwoot, enabling end users to connect with human agents working in a contact center that uses Chatwoot. The Chatwoot integration allows users to receive text messages, files, videos (MP4), images (JPG, PNG), and GIFs. Cognigy supports Chatwoot API v1.19.0, custom agent bot names and descriptions, and full conversation history.Prerequisites
- Access to Chatwoot. You can also run Chatwoot on an on-premises environment.
- Created endpoint compatible with Chatwoot.
- You need two IDs that are listed in the Chatwoot address line:
- Account ID — a unique identifier assigned to you as the user.
- Inbox ID — not unique and is created again for each channel.
Both IDs are required to use the new Inbox channel. You can find them in your Chatwoot URL. For example,https://app.chatwoot.com/app/account/6607/inbox/5446, where the Account ID is6607and the Inbox ID is5446.
Configuration on the handover provider side
1. Add agents in Chatwoot
1. Add agents in Chatwoot
To enable agents to handle handovers, add them in your Chatwoot instance:
- Go to the Chatwoot home page.
- In the left-side Settings menu, select Agents.
- Add a new agent as needed.
2. Set up a webhook for an inbox
2. Set up a webhook for an inbox
To configure Chatwoot to receive incoming messages via a webhook:
The new API channel appears in your Chatwoot inbox list.
- On the Chatwoot main page, go to the left-side menu and click Inboxes.
- Click Add Inbox to start creating a new inbox.
- Select API channel and provide a channel name.
- In the Webhook URL field, enter your Cognigy endpoint base URL appended with
/handover/chatwoot/, for example,https://endpoint-trial.cognigy.com/handover/chatwoot. - Click Create API Channel.
- Assign an agent to the inbox by selecting them and clicking Add agents.

Configuration on the Cognigy side
1. Create a handover provider
1. Create a handover provider
To link your Cognigy endpoint to Chatwoot:
- Go to Deploy > Handover Providers and click + Create handover provider.
- In the Create handover provider dialog, select Chatwoot and click Create handover provider. The handover provider editor opens.
- In the handover provider editor, configure the following:
- Name — enter a unique name for your handover provider.
- API base URL — the URL of your Chatwoot instance, which is your Chatwoot installation URL extended with
/api/v1, for example,https://app.chatwoot.com/api/v1. For on-premises setups, use your custom Chatwoot API URL. - Account ID — the Chatwoot account ID.
- Authentication — select a Chatwoot connection or create a new one. Enter the Chatwoot API key in the connection.
- Click Save changes.
- Test the setup by opening the endpoint editor, clicking Open Demo Webchat, and initiating a conversation that triggers a handover.
2. Add a handover to human agent node
2. Add a handover to human agent node
To specify the Chatwoot inbox for the handover:
- In the flow editor, add a Handover to Human Agent node.
- Open the node editor and, in the Handover provider field, select the Chatwoot handover provider.
- In the Inbox ID field below it, enter the inbox ID. You can use CognigyScript to dynamically select an inbox ID based on the conversation context.
Human agents can resolve a conversation once the user’s request is addressed. If the user sends a new request, the human agent can reopen the conversation in Chatwoot to continue assisting.