ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Overview

This node interacts with the ChatWoot API to list all custom filters associated with a specified account. It is useful for retrieving and managing different types of filters such as conversation filters, contact filters, or report filters within a ChatWoot account. Practical applications include automating workflows that require filtering conversations or contacts based on predefined criteria, or generating reports filtered by specific parameters.

Properties

Name Meaning
Account Id The numeric ID of the ChatWoot account for which to list custom filters (required).
Filter Type The type of custom filter to retrieve. Options: Conversation, Contact, Report.

Output

The node outputs a JSON array containing the list of custom filters matching the specified account ID and filter type. Each item in the output typically represents a filter object with its properties as defined by the ChatWoot API. The exact structure depends on the API response but generally includes filter identifiers, names, and criteria.

No binary data output is produced by this node.

Dependencies

  • Requires an active connection to the ChatWoot API.
  • Needs an API authentication token configured in the node credentials.
  • The base URL for the ChatWoot instance must be provided in the credentials configuration.

Troubleshooting

  • Missing or invalid Account Id: Ensure the Account Id is correctly set as a number and corresponds to an existing ChatWoot account.
  • Invalid Filter Type: Use one of the allowed options (Conversation, Contact, Report) to avoid errors.
  • Authentication errors: Verify that the API key or token is valid and has sufficient permissions.
  • Network issues: Confirm that the ChatWoot instance URL is reachable from n8n.
  • API rate limits: If requests fail due to rate limiting, consider adding delays or retries.

Links and References

Discussion