ChatWoot icon

ChatWoot

Interact with ChatWoot API
Join our community

Actions113

Overview

This node interacts with the ChatWoot API to filter contacts based on specified criteria. It is useful when you want to retrieve a subset of contacts from an account by applying attribute-based filters, such as filtering contacts by name or country code. For example, you could use this node to get all contacts named "en" located in the US within a specific account.

Properties

Name Meaning
Account Id The numeric ID of the account whose contacts you want to filter.
Page The page number for paginated results (optional).
Payload A JSON array defining filter conditions. Each condition includes:
- attribute_key: The contact attribute to filter by (e.g., "name", "country_code").
- filter_operator: The operator to apply (e.g., "equal_to").
- values: An array of values to match against the attribute.
- query_operator: Logical operator to combine multiple filters ("AND", "OR", or null).

Output

The node outputs JSON data representing the filtered list of contacts retrieved from the ChatWoot API. The structure typically includes contact details matching the filter criteria. There is no indication that binary data is returned.

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 HTTP requests to communicate with the ChatWoot REST API.

Troubleshooting

  • Invalid Account Id: If the account ID is incorrect or does not exist, the API will return an error or empty results. Verify the account ID before running the node.
  • Malformed Payload: The payload must be valid JSON and follow the expected filter format. Invalid JSON or incorrect filter keys/operators may cause request failures.
  • Authentication Errors: Ensure the API key credential is correctly set up and has sufficient permissions.
  • Pagination Issues: If many contacts match the filter, use the Page property to paginate through results.

Links and References

Discussion