ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

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 ticket creation.

Properties

Name Meaning
Account Id The numeric ID of the account under which 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 where the conversation is created. Allowed types include Website, Phone, API, Email.
Contact Id The contact's ID for whom the conversation is created.
Additional Attributes JSON object specifying extra attributes like browser information.
Custom Attributes JSON object for saving custom key-value pairs as attributes related to the conversation.
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 JSON data representing the newly created conversation object returned by the ChatWoot API. This typically includes details such as conversation ID, status, timestamps, assigned agents or teams, and any messages associated with the conversation. The output does not include binary data.

Dependencies

  • Requires an API key credential for authenticating with the ChatWoot API.
  • The base URL for the ChatWoot instance must be configured in the node credentials.
  • The node uses the ChatWoot REST API endpoint to create conversations.

Troubleshooting

  • Missing Required Fields: Ensure that required fields like Account Id, Source Id, and Inbox Id are provided; otherwise, the API call will fail.
  • Invalid JSON in Attributes or Message: The additional_attributes, custom_attributes, and message fields expect valid JSON strings. Invalid 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 key used must have permissions to create conversations in the specified account and inbox.
  • Status Value Errors: Only "open", "resolved", or "pending" are accepted for the status field.

Links and References

Discussion