ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Overview

This node interacts with the Conversations API to list all conversations associated with a specific contact within a given inbox. It is useful for retrieving conversation history or monitoring ongoing interactions for customer support, sales follow-ups, or engagement tracking.

Practical examples include:

  • Fetching all chat conversations of a particular customer to review past communications.
  • Integrating conversation data into CRM systems for unified customer profiles.
  • Automating workflows based on conversation status or content.

Properties

Name Meaning
Inbox Identifier The unique identifier of the inbox channel from which to retrieve conversations.
Contact Identifier The unique source ID of the contact whose conversations are to be listed.

Output

The node outputs JSON data containing a list of conversations related to the specified contact in the given inbox. Each conversation entry typically includes details such as conversation ID, timestamps, messages, status, 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 output focuses on JSON conversation data.

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 @devlikeapro/n8n-openapi-node package for OpenAPI integration.
  • Uses an OpenAPI specification (openapi.json) bundled with the node for request building.

Troubleshooting

  • Missing or invalid Inbox Identifier or Contact Identifier: Ensure both identifiers are correctly obtained from prior API calls or system records.
  • Authentication errors: Verify that the API key credential is valid and has sufficient permissions.
  • Network or connectivity issues: Check the base URL configuration and network access to the ChatWoot server.
  • Empty results: Confirm that the contact has existing conversations in the specified inbox.

Links and References

Discussion