ChatwootInstall

Overview

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

Common scenarios where this node is beneficial include:

• Retrieving all labels to categorize or filter conversations, contacts, or other entities in Chatwoot.
• Synchronizing label data from Chatwoot into other systems or workflows.
• Automating workflows based on label information, such as triggering actions when certain labels exist.

Example use case:

• A customer support team wants to pull all available labels from their Chatwoot account to display them in a dashboard or use them for automated ticket routing.

Properties

Output

The node outputs JSON data representing the labels retrieved from the Chatwoot API. For the "Get Many" operation on the Label resource, the output is an array of label objects, each containing properties such as the label's ID, title, and other metadata as returned by the API.

The output structure is:

[
  {
    "json": {
      "id": 123,
      "title": "Support",
      "created_at": "2023-01-01T12:00:00Z",
      "updated_at": "2023-01-02T12:00:00Z",
      ...
    }
  },
  {
    "json": {
      "id": 124,
      "title": "Billing",
      "created_at": "2023-01-03T12:00:00Z",
      "updated_at": "2023-01-04T12:00:00Z",
      ...
    }
  }
]

No binary data output is involved in this operation.

Dependencies

• Requires an API key credential for authenticating with the Chatwoot API.
• The node expects configuration of the Chatwoot API base URL and account ID within the credentials.
• Network access to the Chatwoot API endpoint is necessary.

Troubleshooting

• Common issues:

  • Invalid or missing API credentials will cause authentication failures.
  • Network connectivity problems can prevent successful API calls.
  • If the account ID or base URL is incorrect, the API requests will fail.
  • Rate limiting or API quota exceeded errors may occur depending on Chatwoot API limits.

• Error messages:

  • Errors from HTTP requests are logged if debug logging is enabled.
  • JSON parsing errors do not apply here since no JSON input is parsed for this operation.
  • If the API returns an error, it will be included in the node output if "Continue on Fail" is enabled; otherwise, the node execution stops with the error.

• Resolution tips:

  • Verify that the API key credential is correctly set up with valid access token and account ID.
  • Enable debug logging to see detailed request URLs and headers for troubleshooting.
  • Check network connectivity and firewall settings.
  • Confirm that the Chatwoot API endpoint is reachable and operational.

Links and References

• Chatwoot API Documentation - Labels
• n8n Documentation - Creating Custom Nodes
• Chatwoot Official Website