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 operation allows users to create a custom filter within the ChatWoot platform. Custom filters help segment or organize data such as conversations, contacts, or reports based on specific criteria defined by the user. This is particularly useful for automating workflows, reporting, or managing large datasets by applying reusable query filters.
For example, a support team might create a custom filter to isolate all conversations tagged as "urgent" or a sales team could filter contacts based on region or engagement level.
Properties
| Name | Meaning |
|---|---|
| Account Id | The numeric ID of the account where the custom filter will be created. |
| Filter Type | The category of the custom filter. Options: Conversation, Contact, Report. |
| Name | The name assigned to the custom filter for identification. |
| Type | Describes the type of the custom filter. Options: Conversation, Contact, Report. |
| Query | A JSON object representing the query conditions that define the custom filter's logic. |
Output
The node outputs JSON data representing the newly created custom filter as returned by the ChatWoot API. This typically includes details such as the filter's ID, name, type, query parameters, and associated account information.
No binary data output is involved in this operation.
Dependencies
- Requires an active connection to the ChatWoot API.
- Needs an API authentication token configured in n8n credentials to authorize requests.
- The base URL for the ChatWoot instance must be set in the credentials.
Troubleshooting
- Invalid Account Id: Ensure the provided account ID exists and the API key has access rights to it.
- Malformed Query JSON: The
Queryproperty must be valid JSON; otherwise, the API will reject the request. - Authentication Errors: Verify that the API key credential is correctly configured and has sufficient permissions.
- Filter Type/Type Mismatch: Both
Filter TypeandTypeproperties should match one of the allowed options (conversation, contact, report). Mismatches may cause errors. - API Connectivity Issues: Check network connectivity and the correctness of the ChatWoot base URL.