ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions100

Overview

This node allows you to create a new conversation in ChatWoot via the Conversations API. It is useful for automating the process of starting conversations with contacts in specific inboxes, such as when integrating customer support workflows or triggering outreach based on events in other systems.

Example scenarios:

  • Automatically creating a support ticket (conversation) when a new customer inquiry is received.
  • Initiating a conversation with a contact after they complete a form on your website.
  • Integrating with CRM or marketing tools to start conversations based on user actions.

Properties

Display Name Type Description
Inbox Identifier String The identifier obtained from API inbox channel. Required.
Contact Identifier String The source id of contact obtained on contact create. Required.
Custom Attributes JSON Custom attributes of the conversation. Optional; key-value pairs.

Output

The output will be a json object representing the newly created conversation. The structure typically includes fields such as:

  • id: Unique identifier of the conversation.
  • inbox_id: The ID of the inbox where the conversation was created.
  • contact_id: The ID of the contact associated with the conversation.
  • custom_attributes: Any custom attributes provided during creation.
  • Additional metadata as returned by the ChatWoot API.

Note: The exact structure depends on the ChatWoot API response.

Dependencies

  • External Service: Requires access to a ChatWoot instance with API enabled.
  • API Key: You must provide valid ChatWoot API credentials (chatwootApi) in n8n.
  • Environment Variable: The base URL for ChatWoot must be set in the credentials (url).

Troubleshooting

Common issues:

  • Invalid Credentials: If the API key or URL is incorrect, authentication errors will occur. Double-check your ChatWoot credentials in n8n.
  • Missing Required Fields: Both "Inbox Identifier" and "Contact Identifier" are required. Omitting them will result in validation errors.
  • Malformed Custom Attributes: Ensure that "Custom Attributes" is valid JSON. Invalid JSON will cause parsing errors.

Error messages you might encounter:

  • "401 Unauthorized": Check your API key and URL.
  • "400 Bad Request": Likely due to missing or invalid input properties.
  • "500 Internal Server Error": Could indicate an issue with the ChatWoot server or network connectivity.

Links and References

Discussion