ChatWoot

Overview

This node interacts with the ChatWoot API to retrieve detailed information about a specific contact within an account. It is useful when you need to fetch comprehensive data about a contact, such as their profile details, communication history, or other metadata stored in ChatWoot. Practical scenarios include customer support workflows where agents require quick access to contact details or automation processes that enrich CRM records with up-to-date contact information.

Properties

Output

The node outputs JSON data containing the full details of the specified contact as returned by the ChatWoot API. This typically includes fields such as contact name, email, phone number, custom attributes, and possibly conversation history or tags associated with the contact.

If the API supports binary data related to contacts (e.g., profile images), the node would also handle binary output accordingly, but this is not explicitly indicated in the provided code.

Dependencies

• Requires an API key credential for authenticating with the ChatWoot API.
• The base URL for the ChatWoot instance must be configured in the node credentials.
• The node depends on the @devlikeapro/n8n-openapi-node package for building properties from the OpenAPI specification.

Troubleshooting

• Invalid Account Id or Contact Id: If either ID is incorrect or does not exist, the API will likely return an error or empty response. Verify IDs before running the node.
• Authentication Errors: Ensure the API key credential is valid and has sufficient permissions to access contact details.
• Network Issues: Connectivity problems with the ChatWoot server can cause timeouts or failures. Check network settings and ChatWoot server status.
• Unexpected Response Format: If the API changes its response schema, the node might fail to parse the contact details correctly. Updating the OpenAPI spec or node version may be required.

Links and References

• ChatWoot Official Documentation
• ChatWoot API Reference