Chatwoot icon

Chatwoot

Interact with Chatwoot API
Join our community

Actions36

Overview

The node integrates with the Chatwoot API to manage conversations and related entities. Specifically, the Conversation - Add Labels operation allows users to add one or more labels to an existing conversation by specifying the conversation's numeric ID and the labels to apply.

This operation is useful in scenarios where you want to categorize or tag conversations automatically based on certain criteria, such as marking conversations as "urgent," "billing," or "support." For example, after analyzing a conversation's content, you could use this node to add relevant labels that help your team prioritize or route the conversation appropriately.

Properties

Name Meaning
Conversation ID The numeric ID of the conversation to which labels will be added.
Label Names or IDs A list of labels to add to the conversation. You can select from existing labels or specify IDs using expressions.
Continue on Fail Whether the node should continue processing subsequent items if this operation fails.
Debug Logging Enables detailed logging of request details to the console for troubleshooting purposes.

Output

The output contains the JSON response from the Chatwoot API after adding labels to the specified conversation. This typically includes confirmation of the updated conversation object with its new labels applied.

The structure is:

{
  "json": {
    // Chatwoot API response object representing the updated conversation,
    // including the newly added labels.
  }
}

No binary data is produced 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 within the credentials.
  • Network access to the Chatwoot API endpoint is necessary.

Troubleshooting

  • Invalid Conversation ID: If the conversation ID does not exist or is incorrect, the API will return an error. Verify the ID before running the node.
  • Invalid Labels: Labels must exist in the Chatwoot account. Using non-existent label IDs or names may cause errors.
  • Authentication Errors: Ensure the API key credential is valid and has sufficient permissions.
  • JSON Parsing Errors: Not applicable here since labels are passed as an array, but ensure any expressions used to specify labels produce valid arrays.
  • Continue on Fail: Enable this option if you want the workflow to proceed even if adding labels to one conversation fails.

Enabling Debug Logging helps identify issues by printing detailed request and response information to the console.

Links and References

Discussion