ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Overview

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

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 potentially other metadata depending on the API response.

If the API supports binary data (e.g., attachments), those would be included in the output as binary fields, but this node primarily focuses on textual message data.

Dependencies

  • Requires an API key credential for authenticating with the chat platform's API.
  • The base URL for the API must be configured in the node credentials.
  • The node depends on the external chat platform's Messages API being accessible and responsive.

Troubleshooting

  • Missing or invalid identifiers: Ensure that the Inbox Identifier, Contact Identifier, and Conversation Id are correctly provided and correspond to existing entities in the chat platform.
  • Authentication errors: Verify that the API key credential is valid and has sufficient permissions to access conversation messages.
  • API connectivity issues: Check network connectivity and the correctness of the API base URL.
  • Empty results: If no messages are returned, confirm that the conversation ID is correct and that messages exist in that conversation.

Common error messages might include unauthorized access, resource not found, or bad request due to missing parameters. Resolving these typically involves verifying input properties and credentials.

Links and References

  • Chat platform official API documentation (Messages API section)
  • n8n documentation on creating and using API credentials
  • General REST API troubleshooting guides

Discussion