ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Overview

This node interacts with the Messages API of ChatWoot to list all messages within a specific conversation. It is useful for retrieving the entire message history of a conversation between an inbox channel and a contact. Typical use cases include customer support workflows where agents or automated systems need to fetch past messages to provide context or analyze conversation history.

For example, you might use this node to:

  • Display all messages in a conversation on a dashboard.
  • Analyze conversation content for sentiment or keyword extraction.
  • Archive conversation messages for compliance or record-keeping.

Properties

Name Meaning
Inbox Identifier The unique identifier of the inbox channel from which the conversation originates.
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 object containing the list of messages retrieved from the specified conversation. Each message typically includes details such as message content, sender information, timestamps, and any metadata associated with the message.

If the API supports binary data (e.g., attachments), those would be included in the output as binary fields, but based on the provided code and properties, the primary output is structured JSON data representing conversation messages.

Dependencies

  • Requires an API key credential for authenticating with the ChatWoot API.
  • Needs the base URL of the ChatWoot instance configured in the credentials.
  • Depends on the ChatWoot Messages API being accessible and the identifiers (inbox, contact, conversation) being valid.

Troubleshooting

  • Invalid Identifiers: If the inbox identifier, contact identifier, or conversation ID is incorrect or does not exist, the API will likely return an error or empty results. Verify these IDs before running the node.
  • Authentication Errors: Missing or invalid API credentials will cause authentication failures. Ensure the API key and base URL are correctly set in the node credentials.
  • Network Issues: Connectivity problems to the ChatWoot server can cause timeouts or request failures. Check network access and server status.
  • Permission Denied: The API user may lack permissions to access certain inboxes or conversations. Confirm that the API key has sufficient rights.

Links and References

Discussion