ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Overview

This node interacts with the ChatWoot API to list metadata about conversations filtered by various criteria. Specifically, the "Conversation List Meta" operation under the "Conversations" resource retrieves summarized information about conversations in a ChatWoot account, such as counts or statuses, based on filters like status, inbox, team, labels, and search terms.

Common scenarios where this node is beneficial include:

  • Monitoring conversation volumes by status (e.g., open, resolved) for customer support teams.
  • Filtering conversations by specific inboxes or teams to analyze workload distribution.
  • Searching conversations containing certain keywords to track topics or issues.
  • Integrating conversation metadata into dashboards or reports for real-time insights.

Practical example: A support manager wants to see how many open conversations exist in a particular inbox and team, filtered by specific labels, to allocate resources efficiently.

Properties

Name Meaning
Account Id The numeric ID of the ChatWoot account to query conversations from.
Status Filter conversations by their status. Options: Open, Resolved, Pending, Snoozed.
Q Search term to filter conversations containing messages with this text.
Inbox Id Numeric ID of the inbox to filter conversations belonging to a specific inbox.
Team Id Numeric ID of the team to filter conversations assigned to a specific team.
Labels JSON array of labels to filter conversations tagged with these labels.

Output

The node outputs JSON data representing the metadata of conversations matching the specified filters. This typically includes counts or summaries grouped by conversation attributes such as status or label. The exact structure depends on the ChatWoot API response for the "Conversation List Meta" endpoint.

No binary data output is expected from this operation.

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

  • Invalid Account Id: Ensure the provided account ID exists and is numeric.
  • Authentication Errors: Verify that the API key/token is correctly configured and has sufficient permissions.
  • Filter Misconfiguration: Incorrect or incompatible filter values (e.g., non-existent inbox or team IDs) may result in empty responses.
  • API Rate Limits: Excessive requests might trigger rate limiting; implement retries or backoff strategies if needed.
  • Malformed Labels JSON: The labels property expects valid JSON; invalid JSON will cause request failures.

Links and References

Discussion