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 list metadata about conversations filtered by various criteria. It is useful for retrieving summarized information about conversations in a ChatWoot account, such as counts or statuses, without fetching full conversation details. Typical use cases include monitoring open or resolved conversations, filtering conversations by team or inbox, and searching conversations containing specific terms.

For example, a support team could use this node to quickly get an overview of how many conversations are currently open or pending in a particular inbox or assigned to a specific team.

Properties

Name	Meaning
Account Id	The numeric ID of the ChatWoot account to query.
Status	Filter conversations by their status. Options: Open, Resolved, Pending, Snoozed.
Q	Search term to filter conversations that contain messages matching this text.
Inbox Id	Numeric ID of the inbox to filter conversations by.
Team Id	Numeric ID of the team to filter conversations by.
Labels	JSON array of labels to filter conversations by associated tags or categories.

Output

The node outputs JSON data representing the metadata of conversations matching the specified filters. This typically includes summary information such as counts or aggregated data about the conversations. The exact structure depends on the ChatWoot API response for the "Conversation List Meta" operation.

No binary data output is expected from this node.

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.
Relies on the ChatWoot REST API endpoint for listing conversation metadata.

Troubleshooting

Invalid Account Id: Ensure the provided account ID exists and is correct; otherwise, the API may return errors or empty results.
Authentication Errors: Verify that the API key credential is valid and has sufficient permissions.
Incorrect Filters: Using invalid or mismatched filter values (e.g., non-existent team or inbox IDs) may result in no data returned.
API Rate Limits: Frequent requests might hit rate limits imposed by ChatWoot; consider adding delays or handling retries.

Common error messages will generally come from the ChatWoot API and should be interpreted accordingly, e.g., 401 Unauthorized for authentication issues or 400 Bad Request for invalid parameters.