ChatWoot icon

ChatWoot

Interact with ChatWoot API
Join our community

Actions113

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 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. This typically includes details such as the filter's ID, name, type, associated account, and the query defining the filter. The output can be used downstream in workflows to reference or apply the created filter.

There is no indication that this node outputs binary data.

Dependencies

  • Requires an API key credential to authenticate 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

  • Common Issues:

    • Invalid or missing Account Id may cause the API request to fail.
    • Incorrectly formatted JSON in the Query property can lead to parsing errors.
    • Authentication failures if the API key or base URL is not correctly set.
    • Using unsupported filter types or mismatched Filter Type and Type properties could cause unexpected behavior.

  • Error Messages:

    • "Unauthorized" — Check API key validity and permissions.
    • "Invalid JSON format" — Ensure the Query field contains valid JSON.
    • "Missing required parameter" — Verify all required fields like Account Id and Name are provided.

Resolving these usually involves verifying input values, ensuring proper authentication setup, and validating JSON syntax.

Links and References

Discussion