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 interacts with the ChatWoot API to retrieve detailed information about a single custom filter associated with a specific account. It is useful when you need to fetch the configuration or metadata of a particular custom filter, for example, to display its settings in a dashboard, audit filter criteria, or use the filter details in further automation workflows.
Practical examples include:
- Retrieving a custom filter's details to verify its conditions before applying it in message routing.
- Fetching filter metadata to synchronize with an external system or reporting tool.
- Using filter details as part of a conditional workflow step based on filter properties.
Properties
| Name | Meaning |
|---|---|
| Account Id | The numeric ID of the account to which the custom filter belongs. |
| Custom Filter Id | The numeric ID of the custom filter whose details are to be retrieved. |
Output
The node outputs JSON data representing the full details of the specified custom filter. This typically includes all properties defined by the ChatWoot API for a custom filter, such as filter criteria, name, status, and any other metadata.
If the API supports binary data related to filters (e.g., attachments or images), the node would handle that accordingly, but based on the provided code and operation, the output is purely JSON.
Dependencies
- Requires an active connection to the ChatWoot API.
- Needs an API authentication token or key configured in the node credentials to authorize requests.
- The base URL for the ChatWoot instance must be set in the credentials.
Troubleshooting
- Invalid Account Id or Custom Filter Id: If either ID does not exist or is incorrect, the API will likely return a 404 error. Verify the IDs before running the node.
- Authentication Errors: Missing or invalid API credentials will cause authorization failures. Ensure the API key/token is correctly configured.
- Network Issues: Connectivity problems to the ChatWoot server will result in request timeouts or errors. Check network access and endpoint availability.
- API Changes: If the ChatWoot API changes, the node might fail to parse responses correctly. Keep the node and API version in sync.
Links and References
- ChatWoot API Documentation (for detailed API endpoints and data structures)
- n8n Documentation (for general usage of HTTP and API nodes)