ChatWoot icon

ChatWoot

Consume ChatWoot API
Join our community

Actions11

Overview

This n8n node allows you to interact with the ChatWoot API, specifically to create a new public conversation. It is useful for automating the creation of conversations in ChatWoot from other workflows or systems, such as when a new customer inquiry is received via a web form or another channel and needs to be logged as a conversation in ChatWoot.

Practical examples:

  • Automatically creating a ChatWoot conversation when a user submits a contact form on your website.
  • Integrating external support channels (like SMS or WhatsApp) by forwarding messages into ChatWoot as new conversations.
  • Logging incoming leads or tickets from third-party platforms directly into ChatWoot.

Properties

Name Type Meaning
Authentication options Selects the authentication method: either direct parameter input or predefined credentials.
BaseUrl string The base URL of your ChatWoot instance (e.g., https://chatwoot.org). Required if using parameter-based authentication.
Inbox Identifier string The identifier of the inbox where the conversation will be created. Required for this operation.

Output

The output is a JSON object representing the newly created conversation in ChatWoot. 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.
  • status: Status of the conversation (e.g., open, resolved).
  • messages: An array of message objects within the conversation.
  • Additional metadata provided by the ChatWoot API.

Note: The exact structure may vary depending on the ChatWoot API response.

Dependencies

  • ChatWoot Instance: You must have access to a running ChatWoot server.
  • API Token: Depending on the authentication method, you need either:
    • A valid ChatWoot API token (for parameter-based authentication), or
    • Predefined ChatWoot credentials configured in n8n.
  • n8n Configuration: If using predefined credentials, ensure they are set up in n8n under "ChatWoot Credentials".

Troubleshooting

  • Authentication Errors:
    • Error Message: "Authentication failed" or similar.
      Resolution: Check that your API token and BaseUrl are correct. If using predefined credentials, verify their configuration in n8n.
  • Missing Required Fields:
    • Error Message: "Inbox Identifier is required" or similar.
      Resolution: Ensure you provide a valid Inbox Identifier.
  • Invalid BaseUrl:
    • Error Message: "Base URL is invalid" or connection errors.
      Resolution: Make sure the BaseUrl points to your ChatWoot instance and is accessible from n8n.

Links and References

Discussion