ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Contacts → Contact Filter

AI-generated

Overview

The node integrates with the ChatWoot API to filter contacts based on specified criteria. It allows users to query contacts within a particular account by applying complex filters on contact attributes. This is useful for segmenting contacts, targeting specific groups for messaging campaigns, or extracting subsets of contacts matching certain conditions.

For example, you can filter contacts in an account where the contact's name equals "en" and the country code equals "us". This helps in narrowing down large contact lists to relevant entries.

Properties

Name Meaning
Account Id The numeric ID of the account whose contacts you want to filter.
Page The page number of results to retrieve (for pagination).
Payload A JSON array defining filter conditions on contact attributes. Each filter includes:
- attribute_key: the contact attribute to filter on (e.g., "name", "country_code").
- filter_operator: the comparison operator (e.g., "equal_to").
- values: an array of values to match against.
- query_operator: logical operator to combine this filter with others ("AND", "OR", or null).

Output

The node outputs JSON data representing the filtered list of contacts returned by the ChatWoot API. The structure typically includes contact details matching the filter criteria. If the API supports pagination, the output may also include metadata such as total count and current page.

No binary data output is indicated.

Dependencies

  • Requires an active connection to the ChatWoot API.
  • Needs an API authentication token configured in the node credentials.
  • The base URL for the ChatWoot instance must be set in the credentials.

Troubleshooting

  • Invalid Account Id: Ensure the provided account ID exists and is accessible with your API credentials.
  • Malformed Payload: The payload must be valid JSON and follow the expected filter format. Invalid JSON or incorrect filter keys/operators will cause errors.
  • API Authentication Errors: Verify that the API key/token is correct and has sufficient permissions.
  • Pagination Issues: If requesting pages beyond available data, the response might be empty or error out.

Common error messages:

  • 401 Unauthorized: Check API credentials.
  • 400 Bad Request: Validate the filter payload JSON structure.
  • 404 Not Found: Confirm the account ID is correct.

Links and References

Discussion