ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Overview

This node interacts with the Conversations API of a chat platform to list all conversations associated with a specific contact within a particular inbox. It is useful for retrieving conversation history or monitoring ongoing interactions between contacts and support agents or chatbots.

Typical use cases include:

  • Fetching all conversations for a customer to analyze communication history.
  • Integrating conversation data into CRM or helpdesk systems.
  • Automating workflows based on conversation status or content.

For example, a support team could use this node to pull all conversations related to a customer’s identifier from a designated inbox to review past issues before responding.

Properties

Name Meaning
Inbox Identifier The unique identifier of the inbox channel where conversations are held.
Contact Identifier The unique source ID of the contact whose conversations you want to list.

Output

The node outputs JSON data containing a list of conversations related to the specified contact in the given inbox. Each item in the output typically includes details such as conversation IDs, timestamps, statuses, messages, and participants.

If the API supports binary data (e.g., attachments), the node would handle it accordingly, but based on the provided code and properties, the primary output is structured JSON representing conversation metadata and content.

Dependencies

  • Requires an API key credential for authenticating with the chat platform's API.
  • Needs the base URL of the chat service configured in the node credentials.
  • Depends on the Conversations API endpoint that supports listing conversations by inbox and contact identifiers.

Troubleshooting

  • Missing or invalid Inbox Identifier: Ensure the inbox identifier is correctly obtained from the API and passed to the node.
  • Invalid Contact Identifier: Verify the contact ID exists and is correctly formatted.
  • Authentication errors: Confirm that the API key or authentication token is valid and has sufficient permissions.
  • Empty results: This may indicate no conversations exist for the given contact in the specified inbox.
  • API rate limits or connectivity issues: Check network access and API usage quotas.

Links and References

  • Chat platform Conversations API documentation (replace with actual URL)
  • n8n documentation on creating and using API credentials
  • General REST API best practices for pagination and filtering

Discussion