ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Overview

This node interacts with the ChatWoot API to update an existing custom filter associated with a specific account. Custom filters in ChatWoot allow users to save complex queries for conversations, contacts, or reports, enabling quick access to frequently used filtered views.

Typical use cases include:

  • Modifying saved filters to refine search criteria without recreating them.
  • Automating updates to filters based on changing business needs or reporting requirements.
  • Managing filters programmatically as part of larger workflow automations involving customer support data.

For example, a user might update a custom filter to change its name and query parameters to better reflect new conversation tagging rules.

Properties

Name Meaning
Account Id The numeric ID of the ChatWoot account where the custom filter exists.
Custom Filter Id The numeric ID of the custom filter that you want to update.
Name The new name for the custom filter.
Type The type/category of the custom filter. Options: Conversation, Contact, Report.
Query A JSON object representing the query conditions that define the custom filter's criteria.

Output

The node outputs JSON data representing the updated custom filter as returned by the ChatWoot API. This typically includes details such as the filter's ID, name, type, query, creation and update timestamps, and possibly metadata about the account or user who owns it.

No binary data output is involved.

Dependencies

  • Requires an API key credential for authenticating with the ChatWoot API.
  • The base URL for the ChatWoot instance must be configured in the node credentials.
  • The node depends on the @devlikeapro/n8n-openapi-node package for OpenAPI integration.

Troubleshooting

  • Invalid Account or Filter ID: If the provided account or custom filter ID does not exist, the API will return an error. Verify IDs are correct and correspond to existing resources.
  • Malformed Query JSON: The query property must be valid JSON. Invalid JSON will cause parsing errors. Use proper JSON formatting.
  • Authentication Errors: Ensure the API key credential is valid and has sufficient permissions to update custom filters.
  • Network Issues: Connectivity problems to the ChatWoot server can cause request failures. Check network settings and endpoint availability.

Links and References

Discussion