ChatWoot

Overview

The Conversation List Meta operation for the Conversations resource in this custom n8n node allows users to retrieve metadata about conversations from a ChatWoot account. This is particularly useful for support teams or administrators who need to filter, search, and analyze conversation data based on various criteria such as status, inbox, team, or labels.

Common scenarios:

• Generating reports on open, resolved, pending, or snoozed conversations.
• Filtering conversations by specific inboxes or teams.
• Searching for conversations containing certain keywords.
• Segmenting conversations by custom labels for analytics or workflow automation.

Practical example:
A support manager wants to list all "open" conversations assigned to a particular team and inbox, possibly filtered by a keyword, to monitor workload and response times.

Properties

Output

The output will be a json object containing the metadata of the conversations that match the provided filters. The structure typically includes:

{
  "meta": {
    "count": 123,
    "open": 45,
    "resolved": 60,
    "pending": 10,
    "snoozed": 8
  }
}

• meta.count: Total number of conversations matching the filters.
• meta.open, meta.resolved, meta.pending, meta.snoozed: Counts per status.

Note: The actual fields may vary depending on the ChatWoot API version and configuration.

Dependencies

• External Service: Requires access to a ChatWoot instance.
• API Credentials: Needs a valid ChatWoot API key configured in n8n credentials under chatwootApi.
• Environment Variable: The base URL for the ChatWoot instance must be set in the credentials (url field).

Troubleshooting

Common issues:

• Invalid Account Id: Ensure the Account Id is correct and exists in your ChatWoot instance.
• Authentication Errors: Make sure the API key and URL are correctly set in n8n credentials.
• Empty Results: Double-check your filters (status, inbox, team, labels) to ensure they match existing conversations.
• Malformed Labels JSON: When using the Labels property, ensure it is a valid JSON array (e.g., ["support", "priority"]).

Error messages you might encounter:

• "401 Unauthorized": Check your API key and permissions.
• "404 Not Found": The specified Account Id, Inbox Id, or Team Id does not exist.
• "400 Bad Request": One or more parameters are invalid (e.g., malformed JSON in Labels).

Links and References

• ChatWoot API Documentation
• n8n Documentation: Custom Nodes
• ChatWoot Official Website