ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

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.

For example, you might use this node to fetch all contacts from a particular account sorted by their last activity date to prioritize outreach or follow-up actions.

Properties

Name Meaning
Account Id The numeric ID of the ChatWoot account whose contacts you want to list (required).
Sort The attribute by which the contact list should be sorted. Options:
- Name (ascending)
- Email (ascending)
- Phone Number (ascending)
- Last Activity At (ascending)
- Name (descending)
- Email (descending)
- Phone Number (descending)
- Last Activity At (descending)
Page The page number of results to retrieve (pagination control). Defaults to 1.

Output

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

No binary data output is produced by this node.

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 configuration.

Troubleshooting

  • Invalid Account Id: If the provided account ID does not exist or is incorrect, the API will return an error. Verify the account ID before running the node.
  • 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 result in empty responses. Adjust the page number accordingly.
  • Sorting Parameter: Using an unsupported sort value may lead to unexpected results or errors. Use only the provided sort options.

Links and References

Discussion