Chatwoot icon

Chatwoot

Interact with Chatwoot API

Overview

This node interacts with the Chatwoot API to manage messages within conversations of a specified account. The "Get Many" operation under the "Message" resource retrieves multiple messages from a particular conversation. This is useful for scenarios where you want to fetch the entire message history or a subset of messages in a conversation for analysis, reporting, or further processing.

Practical examples:

  • Fetching all messages in a customer support conversation to analyze communication patterns.
  • Retrieving chat history to display in a custom dashboard.
  • Exporting conversation messages for archival or compliance purposes.

Properties

Name Meaning
Account ID The numeric ID of the Chatwoot account from which to retrieve messages.
Conversation ID The numeric ID of the conversation whose messages you want to fetch.
Continue on Fail Whether to continue executing subsequent items if this operation fails (true/false).

Output

The output is an array of JSON objects, each representing a message retrieved from the specified conversation. Each message object contains all the details as returned by the Chatwoot API, such as message content, sender information, timestamps, and metadata.

No binary data is output by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Chatwoot API.
  • The node expects the base URL of the Chatwoot instance to be configured in the credentials.
  • Network access to the Chatwoot API endpoint is necessary.

Troubleshooting

  • Common issues:

    • Invalid or missing Account ID or Conversation ID will cause the API request to fail.
    • Network connectivity problems can prevent successful API calls.
    • Insufficient permissions or invalid API credentials will result in authorization errors.
  • Error messages:

    • Errors returned from the Chatwoot API are passed through; typical messages include "Not Found" if the conversation does not exist or "Unauthorized" if authentication fails.
    • If "Continue on Fail" is false, the node execution will stop on error; setting it to true allows processing remaining items despite failures.
  • Resolution tips:

    • Verify that the Account ID and Conversation ID are correct and exist in your Chatwoot instance.
    • Ensure the API key credential is valid and has appropriate permissions.
    • Check network connectivity and firewall settings.

Links and References

Discussion