Actions100
- Accounts Actions
- Account Users Actions
- Agent Bots Actions
- Users Actions
- Inbox API Actions
- Contacts API Actions
- Conversations API Actions
- Messages API Actions
- CSAT Survey Page Actions
- Account Agent Bots Actions
- Agents Actions
- Canned Responses Actions
- Canned Response Actions
- Custom Attributes Actions
- 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
Overview
This node integrates with the Conversations API of a messaging platform to create new conversation threads. It is useful in scenarios where automated systems or workflows need to initiate conversations programmatically, such as customer support bots starting chats with users, or CRM systems opening new communication channels based on triggers.
For example, when a new lead is captured, this node can create a conversation linked to that lead’s contact information and assign it to a specific inbox for follow-up by support agents.
Properties
| Name | Meaning |
|---|---|
| Inbox Identifier | The unique identifier of the inbox channel where the conversation will be created. |
| Contact Identifier | The source ID of the contact associated with the conversation, obtained during contact creation. |
| Custom Attributes | A JSON object containing any custom attributes to attach to the conversation (e.g., tags, metadata). |
Output
The node outputs JSON data representing the newly created conversation. This typically includes details such as the conversation ID, status, timestamps, linked contact and inbox identifiers, and any custom attributes set during creation.
If binary data were involved (not indicated here), it would represent attachments or media related to the conversation, but this node focuses on JSON conversation data only.
Dependencies
- Requires an API key credential for authenticating with the ChatWoot Conversations API.
- The base URL for the API must be configured in the node credentials.
- The node depends on the
@devlikeapro/n8n-openapi-nodepackage for OpenAPI integration. - The node uses an OpenAPI specification (
openapi.json) bundled within its source for defining available operations and properties.
Troubleshooting
- Missing or invalid Inbox Identifier: Ensure the inbox ID provided exists and is correctly formatted; otherwise, the API will reject the request.
- Invalid Contact Identifier: The contact ID must correspond to an existing contact; otherwise, conversation creation will fail.
- Malformed Custom Attributes JSON: If the JSON string for custom attributes is invalid, parsing errors may occur. Validate JSON syntax before input.
- Authentication Errors: Verify that the API key credential is valid and has sufficient permissions to create conversations.
- Network or API Endpoint Issues: Confirm the base URL is correct and the API service is reachable.
Links and References
- ChatWoot API Documentation — Official API docs for reference on conversation creation and other endpoints.
- OpenAPI Specification — For understanding the OpenAPI format used in the node.
- n8n Documentation — General guidance on using credentials and configuring nodes.