Chatwoot icon

Chatwoot

Interact with Chatwoot API

Overview

This node integrates with the Chatwoot API to manage contacts and their associated data. Specifically, the "Add Labels" operation for the "Contact" resource allows users to add one or more labels to a specified contact by their numeric ID. This is useful in scenarios where you want to categorize or tag contacts dynamically based on workflow conditions, such as marking customers as VIP, support cases, or billing-related.

Practical examples:

  • Automatically tagging a contact as "vip" after a high-value purchase.
  • Adding "support" and "billing" labels to a contact when they submit a related inquiry.
  • Organizing contacts into groups for targeted messaging or reporting.

Properties

Name Meaning
Contact ID The numeric ID of the contact to which labels will be added.
Labels Comma-separated list of label names to add (e.g., "support,billing,vip").
Continue on Fail Whether the node should continue processing subsequent items if this operation fails.
Debug Logging Whether to output detailed request and response information to the console for debugging.

Output

The node outputs JSON data representing the response from the Chatwoot API after adding labels to the contact. The structure typically includes details about the updated contact or confirmation of the label addition. If multiple input items are processed, the output is an array of such JSON objects corresponding to each item.

No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential for authenticating with the Chatwoot API.
  • Needs configuration of the Chatwoot account base URL and account ID within the credentials.
  • Uses HTTP requests to interact with the Chatwoot REST API endpoints.

Troubleshooting

  • Invalid Contact ID: If the provided contact ID does not exist, the API will return an error. Verify the contact ID is correct.
  • Invalid Label Names: Labels must be valid and existing in the Chatwoot system. Misspelled or non-existent labels may cause errors.
  • API Authentication Errors: Ensure the API key credential is correctly configured and has sufficient permissions.
  • JSON Parsing Errors: Not applicable here since labels are simple strings, but other operations might require valid JSON.
  • Network Issues: Check connectivity to the Chatwoot instance URL.
  • Debug Logging: Enable debug logging to see detailed request URLs, headers, and responses to help diagnose issues.

Links and References


If you need further details on other operations or resources, feel free to ask!

Discussion