ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Overview

This node interacts with the ChatWoot API to retrieve a specific custom attribute associated with an account. It is designed to fetch either conversation-level or contact-level custom attributes based on the provided parameters. This functionality is useful in scenarios where you need to programmatically access metadata or custom data fields tied to accounts within ChatWoot, such as for reporting, automation, or integration purposes.

For example, you might use this node to:

  • Retrieve a custom tag or label assigned to a customer account.
  • Access custom settings or preferences stored as attributes on conversations or contacts.
  • Integrate ChatWoot account data with other systems by extracting these custom attributes dynamically.

Properties

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

Output

The node outputs JSON data containing the requested custom attribute information for the specified account. The exact structure depends on the ChatWoot API response but generally includes details about the attribute's value and metadata.

No binary data output is indicated in the source code.

Dependencies

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

Troubleshooting

  • Invalid Account Id: If the 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 the wrong attribute model (conversation vs. contact) may result in no data found. Ensure you select the correct model corresponding to your attribute.
  • Authentication Errors: Missing or invalid API credentials will cause authentication failures. Confirm that the API key/token is correctly configured.
  • API Endpoint Issues: If the ChatWoot base URL is incorrect or the API is unreachable, the node will fail to connect. Check network connectivity and URL correctness.

Links and References

Discussion