Chatwoot icon

Chatwoot

Interact with Chatwoot API

Overview

This node integrates with the Chatwoot API to manage contacts and other related resources. Specifically, the Contact - Filter operation allows users to filter contacts using custom rules via the Chatwoot API. This is useful for workflows that need to segment or retrieve specific subsets of contacts based on criteria such as labels, attributes, or search queries.

Common scenarios include:

  • Retrieving a filtered list of contacts matching certain criteria for targeted messaging.
  • Automating contact management by filtering contacts before performing bulk updates or actions.
  • Integrating Chatwoot contact data into other systems by selectively exporting filtered contacts.

Example: You want to get all contacts who have been labeled as "VIP" and have interacted recently. Using the filter operation, you can specify these rules and retrieve only those contacts.

Properties

Name Meaning
Continue on Fail Whether the node should continue processing subsequent items if this operation fails.
Debug Logging Whether to output detailed request and response information to the console for debugging.

These properties control error handling behavior and logging verbosity during execution.

Output

The node outputs JSON data representing the result of the filter operation from the Chatwoot API. The structure typically includes an array of contact objects matching the filter criteria, each containing fields such as contact ID, name, email, phone number, labels, and custom attributes.

If the operation fails and "Continue on Fail" is enabled, the output will contain an error object describing the failure for that item.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Chatwoot API.
  • The node expects configuration of the Chatwoot account base URL and access token.
  • Network connectivity to the Chatwoot instance is necessary.

Troubleshooting

  • Invalid JSON Errors: When providing custom JSON input (not applicable directly to filter but relevant in other operations), ensure the JSON syntax is correct to avoid parsing errors.
  • Authentication Failures: Verify that the API key credential is valid and has appropriate permissions.
  • API Endpoint Errors: If the Chatwoot API endpoint is unreachable or returns errors, check the base URL configuration and network connectivity.
  • Continue on Fail Behavior: If enabled, errors in individual items will not stop the workflow but will be included in the output; otherwise, errors will halt execution.

Links and References

Discussion