Actions113
- Contacts Actions
- Contact Actions
- Automation Rule Actions
- Help Center Actions
- Conversations Actions
- Conversation Assignment Actions
- Conversation Labels Actions
- Inboxes Actions
- Messages Actions
- Integrations Actions
- Teams Actions
- Custom Filters Actions
- Webhooks Actions
- Reports Actions
- Accounts Actions
- Account Users Actions
- Agent Bots Actions
- Users Actions
- Contacts API Actions
- Inbox API Actions
- Conversations API Actions
- Messages API Actions
- CSAT Survey Page Actions
- Account Agent Bots Actions
- Agents Actions
- Canned Responses Actions
- Custom Attributes Actions
- Canned Response Actions
Overview
This node allows you to create a new conversation in the ChatWoot platform. It is useful for automating customer support workflows by programmatically opening conversations linked to specific accounts, inboxes, and contacts. For example, you can use this node to start a conversation when a user submits a form on your website or when an event triggers a support request in your system.
Properties
| Name | Meaning |
|---|---|
| Account Id | The numeric ID of the account where the conversation will be created. |
| Source Id | The source identifier of the conversation (e.g., a unique external reference). |
| Inbox Id | The ID of the inbox in which the conversation is created. Allowed types include Website, Phone, API, Email. |
| Contact Id | The contact ID associated with the conversation. |
| Additional Attributes | JSON object specifying extra attributes like browser information. |
| Custom Attributes | JSON object for saving custom key-value pairs related to the conversation (e.g., priority number). |
| Status | The status of the conversation; options are Open, Resolved, or Pending. |
| Assignee Id | The agent ID to whom the conversation should be assigned. |
| Team Id | The team ID to assign the conversation to a specific team. |
| Message | JSON object representing the initial message sent to the conversation, including template parameters. |
Output
The node outputs the response from the ChatWoot API after creating the conversation. This typically includes details about the newly created conversation such as its ID, status, timestamps, and any other metadata returned by the API. The output is structured as JSON data.
If binary data were involved (not indicated here), it would represent attachments or media related to the conversation, but this node focuses on JSON-based conversation creation.
Dependencies
- Requires an API key credential for authenticating with the ChatWoot API.
- Needs the base URL of the ChatWoot instance configured in the credentials.
- Depends on the ChatWoot REST API being accessible and properly configured to accept conversation creation requests.
Troubleshooting
- Missing Required Fields: Ensure that required fields like Account Id, Source Id, and Inbox Id are provided; otherwise, the API will reject the request.
- Invalid JSON in Attributes or Message: The
additional_attributes,custom_attributes, andmessagefields expect valid JSON strings. Malformed JSON will cause parsing errors. - Authentication Errors: Verify that the API key and base URL are correctly set in the credentials.
- Permission Issues: The API user must have permissions to create conversations in the specified account and inbox.
- Status Value Errors: Use only the allowed status values ("open", "resolved", "pending") to avoid validation errors.
Links and References
- ChatWoot API Documentation - Official API docs for detailed endpoint info.
- ChatWoot GitHub Repository - Source code and community support.