ChatWoot icon

ChatWoot

Interact with ChatWoot API
Join our community

Actions113

Overview

This node interacts with the Conversations resource of the ChatWoot API, specifically providing a "Conversation Filter" operation. It allows users to filter conversations based on various attributes and conditions defined in a JSON payload. This is useful for scenarios where you want to programmatically retrieve subsets of conversations matching specific criteria, such as filtering by status, language, or other custom attributes.

Practical examples include:

  • Fetching all conversations that are currently pending.
  • Filtering out conversations where the browser language is not English.
  • Combining multiple attribute filters using logical operators (AND/OR) to refine the search results.

Properties

Name Meaning
Account Id The numeric ID of the account whose conversations you want to filter.
Page The page number of the paginated results to retrieve (for navigating through large result sets).
Payload A JSON array defining the filter criteria. Each object specifies an attribute key, filter operator, values, and optional query operator to combine multiple filters. Example structure:
json [ { "attribute_key": "browser_language", "filter_operator": "not_eq", "values": ["en"], "query_operator": "AND" }, { "attribute_key": "status", "filter_operator": "eq", "values": ["pending"], "query_operator": null } ]

Output

The node outputs JSON data representing the filtered list of conversations returned by the ChatWoot API. The exact structure depends on the API response but typically includes conversation details such as IDs, statuses, timestamps, participants, and message summaries.

If binary data were involved (e.g., attachments), it would be included separately, but this operation focuses on JSON conversation data only.

Dependencies

  • Requires an API key credential for authenticating with the ChatWoot API.
  • Needs the base URL of the ChatWoot instance configured in the credentials.
  • Depends on the ChatWoot API being accessible and the user having appropriate permissions to access conversation data.

Troubleshooting

  • Invalid Account Id: If the account ID is incorrect or does not exist, the API will likely return an error or empty results. Verify the account ID before running the node.
  • Malformed Payload: The filter payload must be valid JSON and follow the expected schema. Invalid JSON or unsupported filter operators may cause request failures.
  • Pagination Issues: Requesting pages beyond the available range may return empty results. Adjust the Page property accordingly.
  • Authentication Errors: Ensure the API key credential is valid and has sufficient permissions.
  • API Rate Limits: Excessive requests might trigger rate limiting; handle such errors by retrying after some delay.

Links and References

Discussion