ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Conversations → Conversation List Meta

AI-generated

Overview

This node interacts with the ChatWoot API to list metadata about conversations within a specified account. It is useful for retrieving filtered lists of conversations based on status, search terms, inbox, team, and labels. Typical use cases include monitoring open or pending customer support conversations, searching conversations containing specific keywords, or segmenting conversations by team or inbox.

For example, a support manager could use this node to fetch all open conversations assigned to a particular team or inbox to prioritize responses.

Properties

Name Meaning
Account Id The numeric ID of the ChatWoot account from which to retrieve conversation metadata.
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 belonging to a specific inbox.
Team Id Numeric ID of the team to filter conversations assigned to a particular team.
Labels JSON array of labels to filter conversations tagged with these labels.

Output

The node outputs JSON data representing the metadata of conversations matching the specified filters. This typically includes conversation IDs, statuses, timestamps, and other relevant metadata fields as provided by the ChatWoot API's conversation list meta endpoint.

No binary data output is indicated.

Dependencies

  • Requires an active ChatWoot account and API access.
  • Needs configuration of an API authentication token (API key) credential in n8n to authorize requests.
  • The base URL for the ChatWoot instance must be set in the credentials.

Troubleshooting

  • Invalid Account Id: Ensure the Account Id is correct and that the API key has access to it.
  • Authentication Errors: Verify that the API key credential is valid and has sufficient permissions.
  • Empty Results: Check filter parameters; overly restrictive filters may return no conversations.
  • Malformed Labels JSON: Ensure the Labels property contains valid JSON array syntax.
  • Network Issues: Confirm connectivity to the ChatWoot instance URL.

Links and References

Discussion