ChatwootInstall

Overview

This node interacts with the Chatwoot API to perform various operations on different resources within a Chatwoot account. Specifically, for the Label resource with the Get operation, it retrieves detailed information about a single label by its numeric ID.

This is useful in scenarios where you want to fetch metadata or details about a specific label used in your Chatwoot account, such as its title, color, or other attributes. For example, you might use this node to get label details before applying them to contacts or conversations in an automated workflow.

Properties

Output

The node outputs the JSON response from the Chatwoot API representing the label's details. This typically includes fields such as the label's ID, title, color, and any other metadata provided by the API.

The output structure is:

{
  "json": {
    // Label object returned by Chatwoot API
    "id": 123,
    "title": "Support",
    "color": "#FF0000",
    // ... other label properties
  }
}

No binary data is produced by this operation.

Dependencies

• Requires an API key credential for authenticating with the Chatwoot API.
• Needs the Chatwoot account ID and base URL configured in the credentials.
• The node makes HTTP GET requests to the Chatwoot API endpoint /api/v1/accounts/{accountId}/labels/{labelId}.

Troubleshooting

• Common issues:
  • Invalid or missing API authentication token will cause authorization errors.
  • Providing a non-existent or incorrect Label ID will result in a "not found" error from the API.
  • Network connectivity issues can cause request failures.
• Error messages:
  • If the API returns an error, the node may throw an exception with the error message.
  • When "Continue on Fail" is enabled, errors are captured in the output JSON under an error field instead of stopping execution.
• Resolution tips:
  • Verify that the API key credential is correctly set up and has access to the specified account.
  • Confirm the Label ID exists in your Chatwoot account.
  • Enable debug logging to see detailed request URLs and responses for troubleshooting.

Links and References

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