ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Overview

This node interacts with the ChatWoot API to list all messages within a specific conversation. It is useful for retrieving the full message history of a conversation between an inbox and a contact, enabling workflows that require message auditing, analysis, or synchronization with other systems.

Practical examples include:

  • Fetching conversation messages to display in a custom dashboard.
  • Archiving chat histories for compliance or record-keeping.
  • Triggering follow-up actions based on message content or timestamps.

Properties

Name Meaning
Inbox Identifier The unique identifier of the inbox channel from which to retrieve conversation messages.
Contact Identifier The source ID of the contact involved in the conversation, obtained when the contact was created.
Conversation Id The numeric ID representing the specific conversation whose messages are to be listed.

Output

The node outputs a JSON array containing the messages of the specified conversation. Each item in the array represents a single message with details such as sender, timestamp, message content, and any metadata provided by the ChatWoot API.

If the API supports binary data (e.g., attachments), those would typically be included as references or separate binary properties, but this node primarily focuses on JSON message data.

Dependencies

  • Requires an active connection to the ChatWoot API via an API key credential.
  • The base URL for the ChatWoot instance must be configured in the node credentials.
  • The node depends on the @devlikeapro/n8n-openapi-node package for OpenAPI integration.

Troubleshooting

  • Missing or invalid identifiers: Ensure that the Inbox Identifier, Contact Identifier, and Conversation Id are correctly provided and correspond to existing entities in ChatWoot.
  • Authentication errors: Verify that the API key credential is valid and has sufficient permissions.
  • Network issues: Confirm that the ChatWoot instance URL is reachable from the n8n environment.
  • Empty results: If no messages are returned, check if the conversation ID is correct and that messages exist for that conversation.

Links and References

Discussion