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 contacts from ChatWoot into other systems, generating reports, or filtering contacts based on sorting preferences.

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 support). Defaults to 1.

Output

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

If binary data were supported, it would represent attachments or media related to contacts, but this node focuses on JSON contact data 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 node credentials.
  • The node 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 or empty result. Verify the account ID before running the node.
  • Authentication Errors: Ensure that the API key credential is valid and has sufficient permissions to access contacts.
  • Pagination Issues: If many contacts exist, ensure the Page parameter is set correctly to navigate through pages.
  • Sorting Parameter: Using an unsupported sort value may cause the API to ignore the parameter or return an error. Use one of the predefined options.

Links and References

Discussion