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 a ChatWoot workspace. Typical use cases include syncing contacts to other systems, generating reports, or filtering contacts based on sorting preferences.

For example, you might use this node to fetch all contacts from an account sorted by their last activity date to prioritize outreach efforts.

Properties

Name Meaning
Account Id The numeric ID of the ChatWoot account whose contacts you want to list (required).
Sort Attribute to sort the contact list by. Options: Name, Email, Phone Number, Last Activity At. Prefix with "-" for descending order.
Page The page number of results to retrieve (for pagination). Defaults to 1.

Output

The node outputs JSON data representing a list of contacts retrieved from the specified account. Each contact object typically includes fields such as name, email, phone number, and last activity timestamp.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the ChatWoot API.
  • The base URL for the ChatWoot instance must be configured in the node credentials.
  • Uses the ChatWoot REST API endpoint for fetching contacts.

Troubleshooting

  • Invalid Account Id: If the account ID is incorrect or does not exist, the API will return an error. Verify the account ID before running the node.
  • Authentication Errors: Ensure that the API key credential is valid and has sufficient permissions.
  • Pagination Issues: If many contacts exist, use the "Page" property to paginate through results.
  • Sorting Errors: Use only the supported sort options; invalid values may cause the request to fail.

Links and References

Discussion