ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Conversations → New Conversation

AI-generated

Overview

This node allows you to create a new conversation in the ChatWoot platform. It is useful for automating customer support workflows by programmatically initiating conversations within specified inboxes and associating them with contacts, agents, or teams. Typical use cases include starting support chats triggered by external events, integrating chat initiation into CRM systems, or logging conversations from other communication channels.

For example, when a user submits a support request on a website, this node can automatically open a new conversation in the appropriate inbox, assign it to an agent or team, and send an initial message.

Properties

Name Meaning
Account Id The numeric ID of the ChatWoot account where the conversation will be created.
Source Id Identifier representing the source of the conversation (e.g., website widget, phone number).
Inbox Id ID of the inbox where the conversation is created. Allowed types: Website, Phone, API, Email.
Contact Id Optional contact identifier to associate the conversation with a specific contact.
Additional Attributes JSON object to specify extra attributes like browser information or other metadata.
Custom Attributes JSON object for saving custom key-value pairs related to the conversation, e.g., priority or tags.
Status Status of the conversation; options are "Open", "Resolved", or "Pending".
Assignee Id Agent ID to assign the conversation to a specific agent.
Team Id Team ID to assign the conversation to a specific team.
Message JSON object representing the initial message sent to start the conversation, including template params.

Output

The node outputs JSON data representing the newly created conversation object as returned by the ChatWoot API. This typically includes details such as conversation ID, status, assigned agent/team, timestamps, and any messages associated with the conversation.

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 active ChatWoot account and API access.
  • Needs configuration of an API authentication token credential in n8n to authorize requests.
  • The base URL for the ChatWoot instance must be set in the credentials.
  • Uses the ChatWoot REST API endpoint for creating conversations.

Troubleshooting

  • Missing Required Fields: Ensure that required properties 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, and message fields expect valid JSON strings. Malformed JSON will cause parsing errors.
  • Authentication Errors: Verify that the API token credential is correctly configured and has sufficient permissions.
  • Invalid Inbox or Contact IDs: Using incorrect or non-existent IDs will result in API errors. Confirm these IDs exist in your ChatWoot account.
  • Status Value Issues: Only "open", "resolved", or "pending" are accepted for the status field.

Links and References

Discussion