ChatWootInstall

Overview

This node interacts with the ChatWoot API to list conversations within a specified account. It is useful for retrieving and filtering conversations based on various criteria such as assignee type, status, search terms, inbox, team, labels, and pagination. Typical use cases include monitoring customer support conversations, generating reports on conversation statuses, or integrating conversation data into other workflows.

For example, a user might want to fetch all open conversations assigned to their team in a particular inbox to display them in a dashboard or trigger follow-up actions.

Properties

Output

The node outputs a JSON array of conversation objects retrieved from the ChatWoot API according to the applied filters. Each conversation object typically contains details such as conversation ID, status, assignee information, messages, timestamps, labels, and related metadata.

If binary data were involved (e.g., attachments), it would be included accordingly, but this operation focuses on listing conversation metadata only.

Dependencies

• Requires an API key credential for authenticating with the ChatWoot API.
• The base URL for the ChatWoot instance must be configured in the credentials.
• No additional external dependencies beyond the ChatWoot API.

Troubleshooting

• Invalid Account Id: Ensure the provided account ID exists and the API key has access rights.
• Authentication Errors: Verify that the API key credential is correctly set up and has necessary permissions.
• Empty Results: Check filter parameters; overly restrictive filters may return no conversations.
• Pagination Issues: If many conversations exist, ensure the Page parameter is used correctly to navigate results.
• Malformed Labels JSON: The Labels property expects valid JSON; invalid JSON will cause errors.

Links and References

• ChatWoot API Documentation
• n8n Documentation - Creating Nodes