ChatWoot icon

ChatWoot

Consume ChatWoot API

Actions11

Overview

This n8n node interacts with the ChatWoot API, specifically targeting the "Public" resource and the "Get All Conversation" operation. It is designed to retrieve all public conversations from a specified ChatWoot inbox. This node is useful for scenarios where you need to fetch and process customer conversations from a public-facing inbox, such as aggregating support requests, analyzing conversation trends, or integrating ChatWoot data into other workflows.

Practical examples:

  • Automatically exporting all public conversations for reporting or analytics.
  • Triggering follow-up actions in n8n based on new or updated conversations.
  • Integrating ChatWoot public conversations with CRM or helpdesk systems.

Properties

Display Name Type Meaning
Authentication options Selects the authentication method: either direct parameter entry 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 unique identifier for the ChatWoot inbox whose public conversations you want to retrieve. Required for this operation.

Output

The output is a JSON array where each item represents a public conversation retrieved from the specified ChatWoot inbox. Each object in the array contains the details of a single conversation. The exact structure depends on the ChatWoot API response, but typically includes fields such as:

[
  {
    "id": 12345,
    "inbox_id": "your-inbox-id",
    "status": "open",
    "contact": { /* contact details */ },
    "messages": [ /* array of messages */ ],
    // ...other conversation fields
  }
]
  • If an error occurs and "Continue On Fail" is enabled, the output will include objects with an error field containing the error message.

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 the BaseUrl and 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

Common Issues:

  • Invalid Credentials: If the BaseUrl or Access Token is incorrect, authentication will fail.
  • Missing Inbox Identifier: The "Inbox Identifier" property is required; omitting it will result in errors.
  • Network Errors: Connectivity issues between n8n and the ChatWoot server can cause failures.

Error Messages:

  • "Authentication failed": Check your BaseUrl and Access Token or verify your predefined credentials.
  • "Inbox not found": Ensure the Inbox Identifier is correct and exists in your ChatWoot instance.
  • "Request failed with status code XXX": Indicates an HTTP error; check network connectivity and API endpoint validity.

How to resolve:

  • Double-check all input properties, especially authentication details and the inbox identifier.
  • Test the connection using the credential test feature in n8n.
  • Review ChatWoot server logs for more detailed error information.

Links and References

Discussion