ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Custom Attributes → Get Account Custom Attribute

AI-generated

Overview

This node interacts with the ChatWoot API to retrieve custom attributes associated with an account. Specifically, it supports fetching a single custom attribute for a given account based on the attribute model type. This is useful in scenarios where you want to programmatically access metadata or custom data fields tied to accounts within ChatWoot, such as retrieving specific conversation or contact attributes for automation, reporting, or integration purposes.

Practical examples include:

  • Fetching a custom conversation attribute to tailor automated responses.
  • Retrieving a contact attribute to enrich customer profiles in external systems.

Properties

Name Meaning
Account Id The numeric ID of the account whose custom attribute you want to retrieve.
Attribute Model Selects the type of attribute to fetch: 0 for conversation attribute, 1 for contact attribute.

Output

The node outputs JSON data representing the requested custom attribute of the specified account. The exact structure depends on the ChatWoot API response but generally includes details about the attribute's key, value, and related metadata.

If binary data were involved (not indicated here), it would typically represent files or media linked to the attribute, but this node focuses on JSON attribute data only.

Dependencies

  • Requires an active connection to the ChatWoot API.
  • Needs an API authentication token configured in the node credentials to authorize requests.
  • The base URL for the ChatWoot instance must be set in the credentials.

Troubleshooting

  • Invalid Account Id: If the provided account ID does not exist or is incorrect, the API will likely return an error or empty result. Verify the account ID before running the node.
  • Incorrect Attribute Model: Using an invalid attribute model value may cause the request to fail or return no data. Ensure to select either 0 (conversation attribute) or 1 (contact attribute).
  • Authentication Errors: Missing or invalid API credentials will prevent successful API calls. Confirm that the API key/token is correctly configured.
  • Network Issues: Connectivity problems to the ChatWoot server can cause timeouts or failures. Check network access and the base URL configuration.

Links and References

Discussion