ChatWoot icon

ChatWoot

Consume ChatWoot API

Actions11

Overview

This n8n node integrates with the ChatWoot API, allowing users to interact with ChatWoot resources such as accounts, contacts, and public endpoints. The node is designed to be flexible in authentication, supporting both direct parameter entry and predefined credentials. It is useful for automating workflows that require communication with ChatWoot, such as managing contacts, sending messages, or retrieving account information.

Common scenarios:

  • Automating customer support ticket creation.
  • Syncing contact data between ChatWoot and other platforms.
  • Fetching or updating account details programmatically.

Practical example:
A business could use this node to automatically create a new ChatWoot contact whenever a new lead is added to their CRM.

Properties

Below are the supported input properties relevant to the Default Resource and Operation:

Display Name Type Description
Authentication options Selects the authentication method: "Parameters" (manual entry) or "Predefined Chatwoot Credentials" (uses stored credentials). Required.
BaseUrl string The base URL of your ChatWoot instance (e.g., https://chatwoot.org). Required when using "Parameters" authentication.

Output

  • The node outputs an array of JSON objects.
  • Each object represents the result of the executed operation on the selected resource.
  • If an error occurs and "Continue On Fail" is enabled, the output will include an object with an error field containing the error message.

Example output:

[
  {
    "id": 123,
    "name": "John Doe",
    "email": "john@example.com"
  }
]

or, in case of error:

[
  {
    "error": "Invalid access token"
  }
]

Note: The exact structure of the output depends on the specific resource and operation chosen.

Dependencies

  • External Service: Requires access to a ChatWoot instance.
  • Authentication: Either manual entry of BaseUrl and Access Token, or use of predefined ChatWoot credentials configured in n8n.
  • n8n Configuration: If using predefined credentials, ensure the credential type chatWootTokenApi is set up in n8n.

Troubleshooting

Common issues:

  • Invalid Credentials: If the BaseUrl or Access Token is incorrect, authentication will fail.
  • Missing Required Fields: Not providing required fields like BaseUrl (when using Parameters) will cause errors.
  • API Endpoint Errors: If the ChatWoot API endpoint is unreachable or returns an error, the node will throw an error message.

Error messages:

  • "Authentication successful": Indicates successful connection during credential testing.
  • "Invalid access token" or similar: Check that the Access Token and BaseUrl are correct.
  • "Resource not found": Ensure the specified resource exists in ChatWoot.

How to resolve:

  • Double-check all entered parameters and credentials.
  • Ensure the ChatWoot instance is accessible from the n8n server.
  • Review the error message in the output for specific guidance.

Links and References

Discussion