Actions113
- Contacts Actions
- Contact Actions
- Automation Rule Actions
- Help Center Actions
- Conversations Actions
- Conversation Assignment Actions
- Conversation Labels Actions
- Inboxes Actions
- Messages Actions
- Integrations Actions
- Teams Actions
- Custom Filters Actions
- Webhooks Actions
- Reports Actions
- Accounts Actions
- Account Users Actions
- Agent Bots Actions
- Users Actions
- Contacts API Actions
- Inbox API Actions
- Conversations API Actions
- Messages API Actions
- CSAT Survey Page Actions
- Account Agent Bots Actions
- Agents Actions
- Canned Responses Actions
- Custom Attributes Actions
- Canned Response Actions
Overview
This node interacts with the ChatWoot API to list conversations within a specified account. It is useful for retrieving and filtering conversations based on various criteria such as assignee type, status, search terms, inbox, team, labels, and pagination. Typical use cases include monitoring customer support conversations, generating reports on conversation statuses, or integrating conversation data into other workflows.
For example, a user might want to fetch all open conversations assigned to them in a particular inbox to automate follow-up actions or analyze response times.
Properties
| Name | Meaning |
|---|---|
| Account Id | The numeric ID of the ChatWoot account from which to list conversations (required). |
| Assignee Type | Filter conversations by assignee type. Options: Me, Unassigned, All, Assigned. |
| 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 by. |
| Team Id | Numeric ID of the team to filter conversations by. |
| Labels | JSON array of labels to filter conversations by. |
| Page | Page number for paginating through conversations. |
Output
The node outputs a JSON array of conversation objects retrieved from the ChatWoot API. Each object represents a conversation with its associated metadata such as ID, status, assignee, messages, labels, and timestamps.
If binary data were involved (e.g., attachments), it would be included accordingly, but this operation focuses on listing conversation metadata only.
Dependencies
- Requires an API key credential for authenticating with the ChatWoot API.
- The base URL for the ChatWoot instance must be configured in the credentials.
- No additional external dependencies are required beyond the ChatWoot API access.
Troubleshooting
- Invalid Account Id: Ensure the provided account ID exists and the API key has access to it.
- Authentication Errors: Verify that the API key credential is correctly set up and has necessary permissions.
- Empty Results: Check filters such as assignee type, status, labels, and search query; overly restrictive filters may return no conversations.
- Pagination Issues: If many conversations exist, ensure the page number is correctly incremented to retrieve subsequent results.
Links and References
- ChatWoot API Documentation - Official API docs for detailed endpoint information.
- n8n Documentation - For general guidance on using n8n nodes and credentials.