Chatwoot icon

Chatwoot

Interact with Chatwoot API

Overview

This node operation retrieves multiple conversations from a Chatwoot account based on various filtering criteria. It is useful for scenarios where you want to list or analyze conversations in bulk, such as monitoring customer support interactions, generating reports, or automating workflows that depend on conversation data.

For example, you can use this operation to:

  • Fetch all open conversations assigned to a specific team.
  • Search conversations containing certain keywords like "billing issue".
  • Filter conversations by assignee type (e.g., only those assigned to you).
  • Narrow down conversations by inbox or label.

Properties

Name Meaning
Account ID The numeric ID of the Chatwoot account from which to retrieve conversations.
Assignee Type Filter conversations by assignee status. Options: All, Assigned, Me, Unassigned.
Status Filter Filter conversations by their status. Options: All, Open, Pending, Resolved, Snoozed.
Search Query A search term to find within message content of conversations.
Filter Inbox ID Filter conversations belonging to a specific inbox by its numeric ID.
Filter Team ID Filter conversations assigned to a specific team by its numeric ID.
Filter Label Names or IDs Filter conversations by one or more labels, specified by name or ID.
Continue on Fail Whether to continue executing subsequent items if this operation fails (boolean).

Output

The output is an array of JSON objects, each representing a conversation matching the filter criteria. Each conversation object contains detailed information as returned by the Chatwoot API, including but not limited to:

  • Conversation ID and metadata
  • Status and assignee details
  • Associated inbox and team information
  • Labels applied to the conversation
  • Messages and timestamps

No binary data is output by this operation.

Dependencies

  • Requires an active connection to the Chatwoot API with a valid API authentication token configured in n8n credentials.
  • The base URL of the Chatwoot instance must be set in the credential configuration.
  • The node uses HTTP GET requests to fetch conversation data from endpoints under /api/v1/accounts/{accountId}/conversations.

Troubleshooting

  • Common issues:

    • Invalid or missing Account ID will cause the API request to fail.
    • Incorrect or expired API authentication token will result in authorization errors.
    • Using invalid filter values (e.g., non-existent inbox or team IDs) may return empty results or errors.
    • Network connectivity problems can cause request timeouts or failures.
  • Error messages:

    • "401 Unauthorized": Check that your API key credential is correct and has necessary permissions.
    • "404 Not Found": Verify that the Account ID and any filter IDs (inbox, team, labels) exist.
    • "400 Bad Request": Ensure filter parameters are valid and correctly formatted.
  • To handle errors gracefully, enable the "Continue on Fail" option to allow the workflow to proceed even if some requests fail.

Links and References

Discussion