Actions113
- Accounts Actions
- Account Users Actions
- Agent Bots Actions
- Users Actions
- Inbox API Actions
- Contacts API Actions
- Conversations API Actions
- Messages API Actions
- CSAT Survey Page Actions
- Account Agent Bots Actions
- Agents Actions
- Canned Responses Actions
- Canned Response Actions
- Custom Attributes Actions
- Contacts Actions
- Contact Actions
- Automation Rule Actions
- Help Center Actions
- Conversations Actions
- Conversation Assignment Actions
- Conversation Labels Actions
- Inboxes Actions
- Messages Actions
- Integrations Actions
- Webhooks Actions
- Teams Actions
- Custom Filters Actions
- Reports Actions
Overview
This node allows users to create a custom filter in the ChatWoot system. 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 filters.
For example, a user might create a custom filter to show only conversations from a particular account or filter contacts based on certain attributes. Once created, these filters can be applied repeatedly without redefining the query each time.
Properties
| Name | Meaning |
|---|---|
| Account Id | The numeric ID of the account for which the custom filter is being created. |
| Filter Type | The category of the custom filter. Options: Conversation, Contact, Report. |
| Name | The name assigned to the custom filter for identification purposes. |
| Type | A description/type field for the custom filter, with options matching Filter Type values. |
| Query | A JSON object representing the query criteria that define the custom filter's logic. |
Output
The node outputs JSON data representing the response from the ChatWoot API after creating the custom filter. This typically includes details about the newly created filter such as its ID, name, type, and the saved query. There is no indication that binary data is output by this node.
Dependencies
- Requires an API key credential for authenticating with the ChatWoot API.
- Needs the base URL of the ChatWoot instance configured in credentials.
- Depends on the ChatWoot REST API endpoint for creating custom filters.
Troubleshooting
- Invalid Account Id: If the provided account ID does not exist or is incorrect, the API will likely return an error. Verify the account ID before running the node.
- Malformed Query JSON: The
queryproperty must be valid JSON. Invalid JSON syntax will cause parsing errors. Ensure the JSON is well-formed. - Authentication Errors: Missing or invalid API credentials will prevent the node from connecting to ChatWoot. Confirm that the API key and base URL are correctly set.
- Filter Type/Type Mismatch: Both
filter_typeandtypeproperties accept the same options. Inconsistent values may cause unexpected behavior; ensure they match or are set appropriately. - API Rate Limits or Network Issues: Standard API connectivity issues may occur; check network access and API rate limits if requests fail.