ChatWoot

Overview

This node retrieves the details of a single custom attribute from a ChatWoot account. It is useful when you need to fetch metadata or configuration about a specific custom attribute, for example, to display its settings, validate its existence, or use its properties in further automation steps.

Practical examples:

• Fetching the definition of a custom field before updating contact records.
• Displaying custom attribute information in dashboards or reports.
• Validating that a custom attribute exists before creating or updating related data.

Properties

Output

The output will be a JSON object containing the details of the requested custom attribute. The structure typically includes fields such as the attribute's id, name, type, and other metadata as provided by the ChatWoot API.

{
  "id": 123,
  "name": "custom_attribute_name",
  "display_name": "Custom Attribute Name",
  "description": "Description of the attribute",
  "attribute_type": "string",
  "created_at": "2023-01-01T00:00:00Z",
  ...
}

Note: The actual fields depend on the ChatWoot API response.

Dependencies

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

Troubleshooting

• Missing Credentials:
  Error: "No credentials found"
  Resolution: Ensure you have added and selected the correct ChatWoot API credentials in your n8n workflow.

• Invalid Account Id or Id:
  Error: "Resource not found" or similar error from the API
  Resolution: Double-check that both the Account Id and Custom Attribute Id are correct and exist in your ChatWoot account.

• Permission Denied:
  Error: "Unauthorized" or "Forbidden"
  Resolution: Make sure the API key has sufficient permissions to access custom attributes.

• Network Issues:
  Error: "Could not reach server"
  Resolution: Verify network connectivity and that the ChatWoot instance URL is correct and accessible.

Links and References

• ChatWoot API Documentation
• n8n Documentation: Credentials
• n8n Community Support