ChatWoot icon

ChatWoot

Consume ChatWoot API
Join our community

Actions11

Overview

The "ChatWoot" n8n node allows users to interact with the ChatWoot API. Specifically, for the Public resource and the Get All Messages operation, this node retrieves all messages from a specified public conversation in ChatWoot. This is useful for scenarios where you need to fetch the entire message history of a public conversation, such as for archiving, analytics, or integrating chat data into other workflows.

Practical examples:

  • Automatically exporting all messages from a public ChatWoot conversation to a Google Sheet.
  • Triggering follow-up actions in n8n when new messages appear in a public conversation.
  • Monitoring and analyzing customer interactions in public channels.

Properties

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).
Source ID string Internal source contact identifier, used for search; should be URL-escaped or in HEX format.
Inbox Identifier string Identifier for the inbox associated with the public conversation.
Conversation ID string The unique ID of the conversation whose messages are being retrieved.

Output

The output will be an array of JSON objects, each representing a message from the specified public conversation. Each object typically contains fields such as:

{
  "id": "string",
  "content": "string",
  "created_at": "timestamp",
  "sender": {
    "id": "string",
    "name": "string"
  },
  ...
}

Note: The exact structure depends on the ChatWoot API response for messages. No binary data is returned by this operation.

Dependencies

  • External Service: Requires access to a running ChatWoot instance.
  • Authentication: Either via direct parameters (BaseUrl, Access Token) or predefined ChatWoot credentials (BaseUrl + Token).
  • n8n Configuration: If using predefined credentials, ensure that the credential type chatWootTokenApi is configured in n8n.

Troubleshooting

  • Invalid Credentials:
    Error Message: "Authentication failed" or similar.
    Resolution: Double-check your BaseUrl and Access Token, or verify that your predefined credentials are correct.

  • Missing Required Fields:
    Error Message: "Parameter X is required."
    Resolution: Ensure all required properties (Inbox Identifier, Conversation ID, etc.) are filled in.

  • Incorrect Source ID Format:
    Error Message: "Invalid Source ID."
    Resolution: Make sure the Source ID is properly URL-escaped or in HEX format as required.

  • API Endpoint Not Reachable:
    Error Message: "ENOTFOUND" or "ECONNREFUSED".
    Resolution: Verify that the BaseUrl is correct and the ChatWoot server is accessible from your n8n instance.

Links and References

Discussion