ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Overview

This node interacts with the ChatWoot API to retrieve conversation metrics for a specific account. It is designed to fetch reports that provide insights into conversations associated with an account, which can be useful for monitoring customer support performance or analyzing communication trends.

A common use case would be in customer service automation workflows where you want to gather metrics about how many conversations have occurred, their status, or other aggregated data related to an account's interactions. For example, a support manager might use this node to generate daily reports on conversation volumes to assess team workload.

Properties

Name Meaning
Account Id The numeric ID of the account for which the conversation metrics report will be retrieved. This is a required field.
Type The type of report to retrieve. Currently, only "Account" is supported as a value.

Output

The node outputs JSON data containing the conversation metrics for the specified account. The exact structure depends on the ChatWoot API response but typically includes aggregated statistics about conversations such as counts, statuses, and possibly timestamps.

No binary data output is indicated by the source code.

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.
  • The node uses the ChatWoot REST API endpoint corresponding to conversation metrics reports.

Troubleshooting

  • Invalid Account Id: If the provided account ID does not exist or is incorrect, the API may return an error or empty results. Verify the account ID before running the node.
  • Authentication Errors: Ensure the API key credential is valid and has sufficient permissions to access reports.
  • Network Issues: Connectivity problems with the ChatWoot server will cause request failures. Check network settings and the base URL configuration.
  • Unsupported Report Type: Currently, only the "Account" type is supported. Using other types may result in errors or no data.

Links and References

Discussion