ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

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:

  • Fetching a custom filter's details to verify its conditions before applying it elsewhere.
  • Retrieving filter metadata to synchronize with an external system.
  • Using filter details to dynamically adjust workflow logic 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 specific custom filter whose details are to be retrieved.

Output

The node outputs JSON data containing the detailed information of the specified custom filter. This typically includes all properties and configurations defined for that filter within the ChatWoot system, such as filter criteria, name, status, and any other metadata provided by the API.

No binary data output is expected from this operation.

Dependencies

  • Requires an API key credential for authenticating with the ChatWoot API.
  • The node expects the base URL of the ChatWoot instance to be configured in the credentials.
  • Network access to the ChatWoot API endpoint is necessary.

Troubleshooting

  • Invalid Account Id or Custom Filter Id: If either ID is incorrect or does not exist, the API will likely return an error indicating the resource was not found. Verify the IDs before running the node.
  • Authentication Errors: Ensure the API key credential is valid and has sufficient permissions to access custom filters.
  • Network Issues: Check connectivity to the ChatWoot API URL configured in the credentials.
  • API Rate Limits: If many requests are made in a short time, the API might throttle requests; handle retries accordingly.

Links and References

Discussion