Actions115
- Teams Actions
- Account Users Actions
- Custom Attributes Actions
- Contacts Actions
- Conversation Labels Actions
- Reports Actions
- Accounts Actions
- Contact 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
- Messages Actions
- Automation Rule Actions
- Help Center Actions
- Conversations Actions
- Conversation Assignment Actions
- Inboxes Actions
- Integrations Actions
- Profile Actions
- Custom Filters Actions
- Webhooks Actions
Overview
This node operation allows users to create a custom filter in the Konverte Digital system via the ChatWoot API. It is useful for automating the creation of filters that can categorize or segment data such as conversations, contacts, or reports based on user-defined queries. For example, a user can create a filter to isolate conversations from a specific account or generate reports filtered by certain criteria.
Use Case Examples
- Creating a custom filter to segment conversations for a specific account ID.
- Defining a contact filter to group contacts based on custom attributes.
- Saving a report filter with a specific query to automate report generation.
Properties
| Name | Meaning |
|---|---|
| Account Id | The numeric ID of the account for which the custom filter is being created. |
| Filter Type | The type of custom filter to create, such as conversation, contact, or report. |
| Name | The name assigned to the custom filter. |
| Type | The type classification of the custom filter, similar to Filter Type, indicating the context of the filter. |
| Query | A JSON query object that defines the criteria for the custom filter. |
| Request Options | Additional request options such as batching, SSL certificate validation, proxy settings, and timeout configuration. |
Output
JSON
id- The unique identifier of the created custom filter.account_id- The account ID associated with the custom filter.filter_type- The type of the custom filter (conversation, contact, report).name- The name of the custom filter.type- The type classification of the custom filter.query- The JSON query defining the filter criteria.created_at- Timestamp when the custom filter was created.updated_at- Timestamp when the custom filter was last updated.
Dependencies
- Requires an API key credential for authentication with the Konverte Digital API.
Troubleshooting
- Ensure the account ID is valid and exists in the system to avoid errors related to invalid account references.
- Verify that the JSON query is correctly formatted to prevent parsing errors.
- Check network connectivity and proxy settings if requests fail or time out.
- If SSL certificate validation fails, consider enabling the option to ignore SSL issues, but be aware of security risks.
Links
- ChatWoot API Custom Filters Documentation - Official documentation for managing custom filters via the ChatWoot API.