Actions113
- Contacts Actions
- Contact Actions
- Automation Rule Actions
- Help Center Actions
- Conversations Actions
- Conversation Assignment Actions
- Conversation Labels Actions
- Inboxes Actions
- Messages Actions
- Integrations Actions
- Teams Actions
- Custom Filters Actions
- Webhooks Actions
- Reports Actions
- Accounts Actions
- Account Users Actions
- Agent Bots Actions
- Users Actions
- Contacts API Actions
- Inbox API Actions
- Conversations API Actions
- Messages API Actions
- CSAT Survey Page Actions
- Account Agent Bots Actions
- Agents Actions
- Canned Responses Actions
- Custom Attributes Actions
- Canned Response Actions
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 complex attribute-based filters. For example, you can filter contacts by their name, country code, or any other attribute supported by ChatWoot, enabling targeted communication or data analysis.
A practical use case would be filtering contacts in a customer support system to find all users from a specific country or with a particular name, then performing follow-up actions such as sending messages or exporting data.
Properties
| Name | Meaning |
|---|---|
| Account Id | The numeric ID of the ChatWoot account for which to filter contacts. |
| Page | The page number of the paginated results to retrieve (used for navigating through large sets). |
| Payload | A JSON array defining the filter conditions. Each object specifies an attribute key, operator, values, and how it combines with others (AND/OR). Example: filter contacts where name equals "en" AND country_code equals "us". |
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. If pagination is used, the output may include metadata about pages.
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.
- The node uses the ChatWoot REST API endpoint for filtering contacts.
Troubleshooting
- Invalid Account Id: Ensure the provided account ID exists and is accessible with the given API credentials.
- Malformed Payload: The payload must be valid JSON and conform to the expected filter format. Invalid JSON or incorrect filter keys/operators will cause errors.
- Pagination Issues: Requesting a page number beyond available pages may return empty results.
- Authentication Errors: Verify that the API key and base URL are correctly set in the credentials.
- API Rate Limits: Excessive requests might be throttled; handle retries accordingly.
Links and References
- ChatWoot API Documentation (for detailed info on contact filtering and attributes)
- n8n Documentation on Using API Credentials