ChatWoot

Overview

This node interacts with the ChatWoot API to list contacts associated with a specific account. It is useful for retrieving and managing contact information such as names, emails, phone numbers, and activity data within an account on ChatWoot. Typical use cases include syncing contact lists, exporting contacts for marketing or support purposes, or integrating contact data into other workflows.

Properties

Output

The node outputs JSON data representing the list of contacts retrieved from the ChatWoot API. Each contact object typically includes fields such as name, email, phone number, last activity timestamp, and other relevant contact details. The output can be used downstream in workflows for further processing, filtering, or integration.

If binary data were involved (e.g., profile pictures), it would be included in a separate binary property, but this node focuses on JSON contact data only.

Dependencies

• Requires an active ChatWoot account and API access.
• Needs an API authentication token configured in n8n credentials to authorize requests.
• The base URL for the ChatWoot instance must be set in the credentials.
• Uses the ChatWoot REST API endpoint for contacts listing.

Troubleshooting

• Invalid Account Id: If the account ID is incorrect or does not exist, the API will return an error or empty list. Verify the account ID before running.
• Authentication Errors: Missing or invalid API credentials will cause authorization failures. Ensure the API key/token is correctly configured.
• Pagination Issues: Requesting pages beyond the available range may return empty results. Adjust the page number accordingly.
• Sorting Parameter Errors: Using unsupported sort values might cause the API to ignore the parameter or return errors. Use only the provided options.
• Network/Connectivity Problems: Ensure that the ChatWoot instance URL is reachable from the n8n environment.

Links and References

• ChatWoot API Documentation
• ChatWoot Official Website