Chatwoot icon

Chatwoot

Interact with Chatwoot API

Overview

This node interacts with the Chatwoot API to manage conversations and related entities. Specifically, the "Conversation - Get Many" operation retrieves multiple conversations from a Chatwoot account based on various filtering criteria such as assignee type, status, inbox, team, labels, search query, and pagination.

Use cases include:

  • Fetching all open conversations assigned to a specific team or agent.
  • Retrieving conversations filtered by status (e.g., open, pending, resolved).
  • Searching conversations containing specific keywords in message content.
  • Paginating through large sets of conversations for reporting or processing.

For example, a support team could use this node to pull all unresolved conversations assigned to them for follow-up actions.

Properties

Name Meaning
Additional Options Collection of optional filters and parameters:
- Assignee Type Filter conversations by assignee type: All, Assigned, Me, Unassigned
- Inbox ID Filter conversations by a specific inbox numeric ID
- Label Names or IDs Filter conversations by one or more label names or IDs
- Page Page number for paginated results (minimum 1)
- Search Query (q) Text string to search within message content
- Status Filter by conversation status: All, Open, Pending, Resolved, Snoozed
- Team ID Filter conversations by a specific team numeric ID
Continue on Fail Boolean flag indicating whether to continue processing other items if this operation fails
Debug Logging Boolean flag to enable detailed request/response logging in the console for debugging purposes

Output

The output is an array of JSON objects, each representing a conversation retrieved from the Chatwoot API. Each item corresponds to one conversation's data structure as returned by the API's /conversations endpoint.

The exact fields depend on the Chatwoot API response but typically include conversation metadata such as:

  • Conversation ID
  • Status
  • Assignee information
  • Inbox and team associations
  • Labels
  • Last activity timestamps
  • Messages summary or counts

No binary data is output by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Chatwoot API.
  • The node expects the Chatwoot account ID and base URL to be configured in the credentials.
  • Network access to the Chatwoot instance's API endpoint is necessary.

Troubleshooting

  • Invalid JSON errors: If using JSON input fields elsewhere, ensure JSON syntax is correct; however, this operation does not require JSON input.
  • Authentication failures: Verify that the API key credential is valid and has appropriate permissions.
  • Empty results: Check filter parameters; overly restrictive filters may return no conversations.
  • Pagination issues: Ensure the page number is >= 1; otherwise, the API may reject the request.
  • Debugging: Enable "Debug Logging" to see detailed HTTP request and response logs in the console, which helps diagnose connectivity or API errors.
  • Continue on Fail: If enabled, the node will skip failed items and continue processing others, useful in batch scenarios.

Links and References

Discussion