ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Overview

This node interacts with the ChatWoot API to retrieve metadata about conversations filtered by various criteria. Specifically, the "Conversation List Meta" operation under the "Conversations" resource fetches summary information about conversations in an account, such as counts or statuses, without retrieving full conversation details.

Common scenarios for this node include:

  • Monitoring conversation volumes and statuses (open, resolved, pending, snoozed) for customer support teams.
  • Filtering conversations by inbox, team, or labels to get targeted metrics.
  • Searching conversations containing specific keywords to analyze message content trends.

Practical example: A support manager wants to see how many open conversations exist in a particular inbox and team, filtered by certain labels, to allocate resources efficiently.

Properties

Name Meaning
Account Id The numeric ID of the account to query conversations from.
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 associated tags.

Output

The node outputs JSON data representing metadata about the filtered list of conversations. This typically includes counts or summaries related to the conversations matching the specified filters.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the ChatWoot API.
  • Needs the base URL of the ChatWoot instance configured in credentials.
  • Uses standard HTTP headers for JSON communication (Accept and Content-Type set to application/json).

Troubleshooting

  • Missing or invalid Account Id: Ensure the Account Id is provided and valid; otherwise, the API call will fail.
  • Invalid filter values: Using unsupported status values or malformed JSON for labels may cause errors.
  • Authentication errors: Verify that the API key credential and base URL are correctly configured.
  • Empty results: If no conversations match the filters, the output may be empty or minimal; try broadening filters.
  • API connectivity issues: Network problems or incorrect URLs can prevent successful API calls.

Links and References

Discussion