ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Overview

This node interacts with the ChatWoot API to retrieve summarized conversation statistics reports. Specifically, the "List All Conversation Statistics Summary" operation under the "Reports" resource fetches aggregated data about conversations filtered by different entity types such as account, agent, inbox, label, or team.

Typical use cases include:

  • Monitoring overall conversation metrics for an entire account.
  • Analyzing performance and workload of individual agents.
  • Reviewing statistics related to specific inboxes or labels.
  • Evaluating team-based conversation handling efficiency.

For example, a customer support manager might use this node to generate daily summaries of agent activity or track how many conversations were handled by a particular inbox over a given time period.

Properties

Name Meaning
Account Id The numeric ID of the ChatWoot account for which the report is generated (required).
Type The type of report to generate. Options: Account, Agent, Inbox, Label, Team (required).
Id The identifier of the specific object when the type is agent, inbox, or label (optional).
Since Timestamp indicating the start date/time from which to collect report data (optional).
Until Timestamp indicating the end date/time until which to collect report data (optional).

Output

The node outputs JSON data containing the summarized conversation statistics according to the selected report type and filters. This typically includes aggregated counts and metrics relevant to conversations, such as total conversations, resolved conversations, response times, etc., depending on the ChatWoot API's response structure.

No binary data output is produced by this node.

Dependencies

  • Requires an active ChatWoot account and API access.
  • Needs an API authentication token configured in n8n credentials to authorize requests.
  • The base URL for the ChatWoot instance must be set in the credentials configuration.

Troubleshooting

  • Missing or invalid Account Id: Ensure the Account Id is correctly provided and corresponds to an existing ChatWoot account.
  • Invalid Type or Id combination: When selecting types like agent, inbox, or label, the corresponding Id must be valid; otherwise, the API may return errors or empty results.
  • Date format issues: The Since and Until timestamps should be in a valid ISO 8601 format or as expected by the API; incorrect formats can cause request failures.
  • Authentication errors: Verify that the API key/token is correctly configured and has sufficient permissions.
  • API rate limits or downtime: If requests fail repeatedly, check ChatWoot service status and consider implementing retry logic or backoff.

Links and References

Discussion