ChatWoot

Overview

This node allows you to add a new custom attribute to an account in ChatWoot. It is useful when you need to extend the data model of accounts with additional fields tailored to your business needs, such as tracking extra metadata or categorizing accounts with custom properties.

Common scenarios:

• Adding a "Customer Tier" field to accounts for segmentation.
• Storing custom identifiers or tags on accounts.
• Enabling advanced filtering and reporting based on custom attributes.

Example:
You want to track the "Onboarding Date" for each account. You can use this node to create a new date-type custom attribute called "Onboarding Date" and assign it to all relevant accounts.

Properties

Output

The node returns a json object containing the details of the newly created custom attribute as returned by the ChatWoot API. The structure typically includes:

{
  "id": 123,
  "account_id": 456,
  "attribute_display_name": "Customer Tier",
  "attribute_display_type": 6,
  "attribute_description": "Tier of the customer",
  "attribute_key": "customer_tier",
  "attribute_values": ["Gold", "Silver", "Bronze"],
  "attribute_model": 0,
  // ...other fields as provided by the API
}

Note: The exact output fields depend on the ChatWoot API response.

Dependencies

• External Service: Requires access to a ChatWoot instance.
• API Credentials: Needs a valid chatwootApi credential configured in n8n, including the base URL and authentication token.
• n8n Configuration: Ensure that the credentials are set up under the name chatwootApi.

Troubleshooting

Common Issues:

• Invalid Account Id: If the provided Account Id does not exist, the API may return a "Not Found" error.
• Duplicate Attribute Key: Attempting to add an attribute with a key that already exists may result in a conflict or validation error.
• Malformed Attribute Values: Supplying invalid JSON in "Attribute Values" can cause parsing errors.
• Missing Required Fields: Omitting required fields like "Account Id" or "Attribute Display Name" will result in validation errors.

Error Messages & Resolutions:

• "400 Bad Request": Check that all required fields are filled and correctly formatted.
• "401 Unauthorized": Verify that your chatwootApi credentials are correct and have sufficient permissions.
• "409 Conflict": The attribute key already exists; choose a unique key.

Links and References

• ChatWoot Custom Attributes Documentation
• n8n Credentials Setup Guide
• ChatWoot API Reference