ChatWoot icon

ChatWoot

Consume ChatWoot API

Actions11

Overview

This n8n node allows you to create a new conversation in Chatwoot using the "Public" resource and the "Create Conversation" operation. It is useful for integrating external systems or forms with Chatwoot, enabling automated creation of conversations (such as support tickets or chat threads) directly from workflows. Typical scenarios include capturing website inquiries, automating customer onboarding, or connecting third-party platforms to your Chatwoot inboxes.

Example use cases:

  • Automatically open a new Chatwoot conversation when a user submits a contact form.
  • Integrate with CRM or helpdesk tools to log customer interactions as Chatwoot conversations.
  • Trigger Chatwoot conversations from marketing automation or lead generation workflows.

Properties

Display Name Type Description
Authentication options Select how to authenticate: either by providing parameters manually or using 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 Chatwoot inbox where the conversation will be created.

Output

The node returns a JSON object representing the newly created conversation. While the exact structure depends on the Chatwoot API response, typical fields may include:

{
  "id": 12345,
  "inbox_id": 6789,
  "contact_id": 1111,
  "status": "open",
  "messages": [
    // Array of message objects
  ],
  ...
}

If an error occurs and "Continue On Fail" is enabled, the output will contain an error field with the error message:

{
  "error": "Error message here"
}

Dependencies

  • Chatwoot Instance: You must have access to a running Chatwoot server.
  • API Credentials: Depending on the selected authentication method:
    • Parameters: Requires manual entry of BaseUrl and possibly an Access Token.
    • Predefined Chatwoot Credentials: Uses stored credentials configured in n8n.
  • n8n Configuration: Ensure that any required credentials are set up in n8n's credential manager.

Troubleshooting

  • Authentication Errors:
    • Message: "Authentication failed" or similar.
      Resolution: Check that your BaseUrl and token are correct, and that the account has sufficient permissions.
  • Invalid Inbox Identifier:
    • Message: "Inbox not found" or similar.
      Resolution: Verify that the provided Inbox Identifier matches an existing inbox in your Chatwoot instance.
  • Network/Connection Issues:
    • Message: "ENOTFOUND", "ECONNREFUSED", etc.
      Resolution: Ensure your Chatwoot server is reachable from the n8n instance.
  • Missing Required Fields:
    • Message: "Required parameter missing"
      Resolution: Make sure all required properties (BaseUrl, Inbox Identifier) are filled in.

Links and References

Discussion