ChatWoot

Interact with ChatWoot API

Actions113

Accounts Actions
- Create An Account
- Get Details Of An Account
- Delete An Account
- Update An Account
Account Users Actions
- List All Account Users
- Create An Account User
- Delete An Account User
Agent Bots Actions
- Create An Agent Bot
- Get Details Of A Single Agent Bot
- Delete An Agent Bot
- Update An Agent Bot
Users Actions
- Create A User
- Get Details Of A User
- Delete A User
- Update A User
- Get Sso Url Of A User
Inbox API Actions
- Get Details Of A Inbox
Contacts API Actions
- Create A Contact
- Get Details Of A Contact
- Update A Contact
Conversations API Actions
- List All Contact Conversations
- Create A Conversation
Messages API Actions
- List All Converation Messages
- Create A Message
- Update A Message
CSAT Survey Page Actions
- Get Csat Survey Page
Account Agent Bots Actions
- List All Account Agent Bots
- Create An Account Agent Bot
- Get Details Of A Single Account Agent Bot
- Delete An Account Agent Bot
- Update An Account Agent Bot
Agents Actions
- Get Account Agents
- Add New Agent To Account
- Delete Agent From Account
- Update Agent In Account
Canned Responses Actions
- Get Account Canned Response
- Add New Canned Response To Account
- Delete Canned Response From Account
Canned Response Actions
- Update Canned Response In Account
Custom Attributes Actions
- Get Account Custom Attribute
- Add New Custom Attribute To Account
- Get Details Of A Single Custom Attribute
- Delete Custom Attribute From Account
- Update Custom Attribute In Account
Contacts Actions
- Contact List
- Contact Create
- Contact Details
- Contact Update
- Contact Delete
- Contact Conversations
- Contact Search
- Contact Filter
Contact Actions
- Contact Inbox Creation
- Contactable Inboxes Get
Automation Rule Actions
- Get Account Automation Rule
- Add New Automation Rule To Account
- Get Details Of A Single Automation Rule
- Delete Automation Rule From Account
- Update Automation Rule In Account
Help Center Actions
- Get Portal
- Add New Portal To Account
- Update New Portal To Account
- Add New Category To Account
- Add New Article To Account
Conversations Actions
- Conversation List Meta
- Conversation List
- New Conversation
- Conversation Filter
- Get Details Of A Conversation
- Toggle Status Of A Conversation
- Toggle Priority Of A Conversation
Conversation Assignment Actions
- Assign A Conversation
Conversation Labels Actions
- List All Labels Of A Conversation
- Conversation Add Labels
Inboxes Actions
- List All Inboxes
- Get Inbox
- Inbox Creation
- Update Inbox
- Get Inbox Agent Bot
- Update Agent Bot
- Get Inbox Members
- Add New Agent To Inbox
- Delete Agent In Inbox
- Update Agents In Inbox
Messages Actions
- List All Messages
- Create A New Message In A Conversation
- Delete A Message
Integrations Actions
- Get Details Of All Integrations
- Create An Integration Hook
- Delete An Integration Hook
- Update An Integrations Hook
Teams Actions
- List All Teams
- Create A Team
- Get Details Of A Single Team
- Delete A Team
- Update A Team
- Get Team Members
- Add New Agent To Team
- Delete Agent In Team
- Update Agents In Team
Custom Filters Actions
- List All Filters
- Create A Custom Filter
- Get Details Of A Single Custom Filter
- Delete A Custom Filter
- Update A Custom Filter
Webhooks Actions
- List All Webhooks
- Create A Webhook
- Delete A Webhook
- Update A Webhook
Reports Actions
- List All Conversation Statistics
- List All Conversation Statistics Summary
- Get Account Conversation Metrics
- Get Agent Conversation Metrics

Overview

This node interacts with the ChatWoot API to retrieve conversation metrics for a specific account. It is useful for users who want to analyze or report on conversation data tied to their ChatWoot accounts, such as tracking engagement or performance metrics over time.

A practical example would be fetching conversation statistics for a customer support account to monitor how many conversations were handled, response times, or other aggregated metrics that help evaluate team performance.

Properties

Name	Meaning
Account Id	The numeric ID of the ChatWoot account for which to fetch conversation metrics.
Type	The type of report to retrieve. Currently supports only "Account" as the report type.

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, durations, and statuses.

No binary data output is indicated.

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.

Troubleshooting

Missing or invalid Account Id: Ensure the Account Id is provided and is a valid number; otherwise, the API call will fail.
Authentication errors: Verify that the API key credential and base URL are correctly set up in n8n.
API rate limits or connectivity issues: Network problems or hitting API limits may cause errors; check network access and API usage quotas.
Unsupported report type: Currently, only the "Account" type is supported; using other types will not work.

Links and References

ChatWoot API Documentation (for detailed info on available reports and metrics)
n8n Documentation (for general guidance on using API nodes and credentials)

ChatWootInstall