Chatwoot icon

Chatwoot

Interact with Chatwoot API

Actions35

Overview

This node operation "Add Labels" under the "Conversation" resource allows you to add one or more labels to a specific conversation within an account in Chatwoot. Labels are useful for categorizing, tagging, or organizing conversations based on custom criteria such as priority, topic, or status.

Common scenarios where this node is beneficial include:

  • Automatically tagging conversations with relevant labels based on incoming message content or metadata.
  • Organizing conversations by department, issue type, or customer segment.
  • Enhancing workflow automation by triggering actions based on assigned labels.

For example, you could use this node to add a "Billing Issue" label to all conversations related to payment queries, helping your support team quickly identify and prioritize them.

Properties

Name Meaning
Account ID The numeric ID of the Chatwoot account where the conversation exists.
Conversation ID The numeric ID of the conversation to which labels will be added.
Label Names or IDs Select one or multiple labels from the list or specify their IDs using expressions.
Continue on Fail Whether to continue executing subsequent items if this operation fails (true/false).

Output

The output of this operation is a JSON object representing the updated conversation after the labels have been added. It typically includes details about the conversation including its current state and the newly associated labels.

No binary data is output by this node.

Example output structure (simplified):

{
  "json": {
    "id": 123,
    "account_id": 1,
    "labels": [
      {
        "id": 10,
        "title": "Billing Issue"
      },
      {
        "id": 15,
        "title": "Urgent"
      }
    ],
    // ... other conversation fields
  }
}

Dependencies

  • Requires an API key credential for authenticating with the Chatwoot API.
  • Needs the base URL of the Chatwoot instance configured in credentials.
  • The node makes HTTP POST requests to the endpoint /api/v1/accounts/{accountId}/conversations/{conversationId}/labels.

Troubleshooting

  • Invalid Account or Conversation ID: If the provided account or conversation ID does not exist, the API will return an error. Verify that these IDs are correct.
  • Label Not Found: If a specified label ID or name does not exist in the account, the operation may fail. Ensure labels are pre-created or loaded properly.
  • API Authentication Errors: Check that the API key credential is valid and has sufficient permissions.
  • Continue on Fail: If enabled, the node will continue processing other items even if adding labels fails for some; otherwise, it will stop execution on error.

Links and References

Discussion