ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Conversations → Conversation List

AI-generated

Overview

This node interacts with the Conversations resource of a chat or customer support platform, specifically to list conversations. It allows users to retrieve a filtered and paginated list of conversations based on various criteria such as account ID, assignee type, status, search terms, inbox, team, labels, and page number.

Common scenarios where this node is beneficial include:

  • Fetching all open conversations assigned to a specific user or team for follow-up.
  • Searching conversations containing certain keywords to analyze customer issues.
  • Paginating through large volumes of conversations for reporting or data export.
  • Filtering conversations by status (open, resolved, pending, snoozed) to manage workflow.

Practical example: A support manager wants to get all unresolved conversations assigned to their team in a particular inbox to monitor workload and response times.

Properties

Name Meaning
Account Id The numeric ID of the account to fetch conversations from.
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 pagination through conversations.

Output

The node outputs a JSON array of conversation objects matching the specified filters. Each object represents a conversation with its associated metadata such as IDs, status, assignee info, messages, labels, timestamps, etc.

If binary data were involved (e.g., attachments), it would be summarized here, but this operation focuses on JSON data representing conversations.

Dependencies

  • Requires an API key credential for authenticating with the ChatWoot API.
  • Needs the base URL of the ChatWoot instance configured in credentials.
  • Depends on the ChatWoot API being accessible and responsive.

Troubleshooting

  • Missing or invalid Account Id: The node requires a valid numeric account ID; ensure this is provided and correct.
  • Authentication errors: Verify that the API key credential is correctly set up and has necessary permissions.
  • Invalid filter values: Using unsupported values for assignee type, status, or other filters may cause errors or empty results.
  • Pagination issues: Requesting pages beyond available data will return empty arrays; adjust the page number accordingly.
  • Network or API downtime: Ensure the ChatWoot API endpoint is reachable and operational.

Links and References

Discussion