ChatWoot icon

ChatWoot

Interact with ChatWoot API
Join our community

Actions113

Overview

This node interacts with the ChatWoot API to filter conversations based on specified criteria. It is useful for retrieving subsets of conversations from a ChatWoot account that match certain attribute filters, such as language preferences or conversation status. For example, you could use this node to fetch all pending conversations where the browser language is not English, enabling targeted follow-up or analysis.

Properties

Name Meaning
Account Id The numeric ID of the ChatWoot account from which to retrieve filtered conversations.
Page The page number of results to fetch, supporting pagination through the filtered conversations.
Payload A JSON array defining filter conditions on conversation attributes. Each filter includes:
- attribute_key: the conversation attribute to filter by (e.g., "browser_language", "status")
- filter_operator: the comparison operator (e.g., "eq" for equals, "not_eq" for not equals)
- values: an array of values to compare against
- query_operator: logical operator to combine multiple filters ("AND", "OR", or null)

Output

The node outputs JSON data representing the filtered list of conversations retrieved from the ChatWoot API. The structure typically includes conversation details matching the filter criteria. No binary data output is produced.

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.
  • Pagination support depends on the ChatWoot API's handling of the page query parameter.

Troubleshooting

  • Invalid Account Id: If the provided account ID does not exist or is incorrect, the API will return an error or empty results. Verify the account ID is correct.
  • Malformed Payload JSON: The payload must be valid JSON and conform to the expected filter format. Invalid JSON or unsupported filter keys/operators may cause request failures.
  • Authentication Errors: Ensure the API key credential is valid and has sufficient permissions to access conversations.
  • Pagination Issues: Requesting pages beyond available data will result in empty responses; adjust the Page property accordingly.

Links and References

Discussion