ChatWoot

Overview

This node updates a custom attribute within a specific account in ChatWoot. It is designed for scenarios where you need to modify metadata or custom fields associated with an account, such as updating the display name, type, description, key, values, or model of a custom attribute. This is useful for organizations that use ChatWoot and want to programmatically manage or synchronize custom attributes across their accounts.

Example Use Cases:

• Automatically update a custom field when syncing data from another CRM.
• Change the display type or allowed values of an attribute based on business logic.
• Update attribute descriptions or keys as part of a migration or cleanup process.

Properties

Output

The node outputs a json object containing the response from the ChatWoot API after updating the custom attribute. The structure of this output typically includes details about the updated attribute, such as its ID, display name, type, description, key, values, and model. The exact structure depends on the ChatWoot API's response format.

Example Output Structure:

{
  "id": 123,
  "account_id": 456,
  "attribute_display_name": "Priority",
  "attribute_display_type": 0,
  "attribute_description": "Indicates ticket priority",
  "attribute_key": "priority",
  "attribute_values": ["High", "Medium", "Low"],
  "attribute_model": 0,
  // ...other fields returned by the API
}

Dependencies

• External Service: Requires access to a ChatWoot instance with API enabled.
• API Credentials: You must configure n8n credentials named chatwootApi, which should include at least the base URL (url) and authentication details for your ChatWoot instance.

Troubleshooting

Common Issues:

• Invalid Account or Attribute ID: If the provided Account Id or Id does not exist, the API may return a "Not Found" or similar error.
• Authentication Errors: Missing or incorrect API credentials will result in authentication failures.
• Malformed Attribute Values: If Attribute Values is not valid JSON, the request may fail.
• Insufficient Permissions: The API user must have permission to update custom attributes in the specified account.

Error Messages & Resolutions:

• "401 Unauthorized": Check your API credentials and ensure they are correctly configured in n8n.
• "404 Not Found": Verify that both the Account Id and Attribute Id are correct and exist in ChatWoot.
• "400 Bad Request": Ensure all required fields are filled and that Attribute Values is valid JSON.

Links and References

• ChatWoot API Documentation
• n8n Documentation: Custom Nodes
• ChatWoot Custom Attributes Guide