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 them in a particular inbox to automate follow-ups or analyze response times.

Properties

Output

The node outputs a JSON array of conversation objects retrieved from the ChatWoot API. Each object represents a conversation with its associated metadata such as ID, status, assignee, messages, labels, and timestamps.

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 are required beyond the ChatWoot API access.

Troubleshooting

• Invalid Account Id: Ensure the provided Account Id exists and the API key has access to it.
• Authentication Errors: Verify that the API key credential is correctly set up and has necessary permissions.
• Empty Results: Check filters like assignee type, status, labels, and search query; overly restrictive filters may return no conversations.
• Pagination Issues: If expecting more results, verify the page number and whether the API supports further pages.
• Malformed Labels JSON: Ensure the labels property is valid JSON; invalid JSON will cause request failures.

Links and References

• ChatWoot API Documentation
• ChatWoot Conversations API Reference