Chatwoot

Overview

This node interacts with the Chatwoot API to manage various resources such as accounts, contacts, conversations, messages, inboxes, canned responses, webhooks, teams, and labels. Specifically, for the Label resource with the Get Many operation, it retrieves multiple labels associated with a specified account.

Use cases include:

• Fetching all labels for an account to categorize or filter conversations.
• Integrating label data into workflows for reporting or automation.
• Synchronizing label information between Chatwoot and other systems.

Example: Retrieve all labels for account ID 123 to display them in a dashboard or use them in conditional logic within an automation workflow.

Properties

Output

The output is an array of JSON objects, each representing a label retrieved from the Chatwoot API. Each label object contains properties as defined by the Chatwoot API's label schema (e.g., id, title, created_at, updated_at).

Example output structure:

[
  {
    "id": 1,
    "title": "Support",
    "created_at": "2023-01-01T12:00:00Z",
    "updated_at": "2023-01-02T12:00:00Z"
  },
  {
    "id": 2,
    "title": "Sales",
    "created_at": "2023-01-03T12:00:00Z",
    "updated_at": "2023-01-04T12:00:00Z"
  }
]

No binary data output is produced by this operation.

Dependencies

• Requires an API key credential configured in n8n to authenticate requests to the Chatwoot API.
• The base URL for the Chatwoot instance must be set in the credentials.
• Network access to the Chatwoot API endpoint.

Troubleshooting

• Common issues:

  • Invalid or missing Account ID will cause the API request to fail.
  • Network connectivity problems or incorrect base URL configuration can prevent successful API calls.
  • Insufficient permissions for the API key may result in authorization errors.

• Error messages:

  • "Request failed with status code 404": The specified account or labels were not found. Verify the Account ID.
  • "Request failed with status code 401": Authentication failed. Check the API key credential.
  • "Request failed with status code 500": Server error at Chatwoot. Retry later or contact support.

• To resolve errors, ensure the Account ID is correct, the API key is valid and has necessary permissions, and the Chatwoot instance is reachable.

Links and References

• Chatwoot API Documentation
• n8n HTTP Request Node Documentation
• Chatwoot Labels API Endpoint