ChatWoot

Interact with ChatWoot API

Actions113

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

Overview

This node interacts with the ChatWoot API to retrieve conversation metrics for a specific account. It is designed to fetch detailed reports about conversations associated with an account, which can be useful for analyzing customer support performance or engagement statistics.

Common scenarios include:

Monitoring the volume and quality of conversations handled by a support team.
Generating periodic reports on account activity for management review.
Integrating conversation metrics into dashboards or other analytics tools.

For example, a user might use this node to get the total number of conversations handled by their support account over a given period, helping them understand workload and resource allocation.

Properties

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

Output

The node outputs JSON data containing the conversation metrics retrieved from the ChatWoot API for the specified account. This typically includes various statistics related to conversations such as counts, statuses, timestamps, and possibly aggregated data depending on the API response.

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 depends on the @devlikeapro/n8n-openapi-node package for handling OpenAPI-based requests.

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 that the API key credential is correctly set up and has sufficient permissions to access conversation metrics.
Network Issues: Connectivity problems or incorrect base URL configuration can cause request failures. Confirm the URL and network accessibility.
Unsupported Report Type: Currently, only the "Account" type is supported. Using other types may result in errors or no data.

Links and References

ChatWoot API Documentation (for details on available endpoints and data structures)
n8n Documentation (for general usage of custom nodes and credentials)