ChatWoot

Overview

The Conversation Add Labels operation for the Conversation Labels resource in this custom n8n node allows you to add one or more labels to a specific conversation within a ChatWoot account. This is useful for categorizing, organizing, or tagging conversations for easier filtering and management in customer support workflows.

Common scenarios:

• Automatically tagging incoming conversations based on content or source.
• Organizing conversations by priority, topic, or agent assignment.
• Integrating with automation flows that require labeling for downstream processing.

Example:
When a new support ticket arrives containing the word "billing," you can use this node to automatically add the label "Billing" to the conversation in ChatWoot.

---

Properties

Display Name	Type	Description
Account Id	Number	The numeric ID of the ChatWoot account. (Required)
Conversation Id	Number	The numeric ID of the conversation. (Required)
Labels	JSON	Array of labels (comma-separated strings).

• Account Id: Identifies which ChatWoot account the conversation belongs to.
• Conversation Id: Specifies the exact conversation to which labels will be added.
• Labels: Accepts a JSON array of label strings (e.g., ["urgent", "vip"]). This field expects a valid JSON array input.

---

Output

The node outputs a json object reflecting the result of the label addition operation. The structure typically includes:

{
  "id": <conversation_id>,
  "labels": [
    "label1",
    "label2"
  ],
  // ...other conversation fields as returned by ChatWoot API
}

• id: The ID of the conversation.
• labels: An array of all labels currently assigned to the conversation.
• Additional fields may be present depending on the ChatWoot API response.

Note: This node does not output binary data.

---

Dependencies

• External Service: Requires access to a ChatWoot instance.
• API Key: Needs valid ChatWoot API credentials (chatwootApi) configured in n8n.
• Environment Variable: The base URL for ChatWoot must be set in the credentials (url).

---

Troubleshooting

Common Issues:

• Invalid Credentials: If the API key or URL is incorrect, authentication errors will occur.
• Malformed Labels Input: The "Labels" property must be a valid JSON array. Supplying an invalid format (e.g., plain string or malformed JSON) will cause parsing errors.
• Missing Required Fields: Omitting "Account Id" or "Conversation Id" will result in validation errors.

Error Messages & Resolutions:

• "401 Unauthorized": Check your ChatWoot API credentials and ensure they are correct.
• "400 Bad Request": Verify that "Labels" is a properly formatted JSON array and that all required fields are provided.
• "404 Not Found": Ensure the specified "Account Id" and "Conversation Id" exist in your ChatWoot instance.

---

Links and References

• ChatWoot API Documentation
• n8n Documentation: Custom Nodes
• How to Format JSON Arrays