ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Overview

This node integrates with the Contacts API of ChatWoot to create a new contact within a specified inbox. It is useful for automating customer management workflows, such as adding new users from form submissions, CRM systems, or other data sources directly into ChatWoot’s contact list. For example, when a new lead fills out a signup form, this node can automatically create a corresponding contact in ChatWoot to enable seamless communication and tracking.

Properties

Name Meaning
Inbox Identifier The unique identifier of the inbox channel where the contact will be created (required).
Identifier An external identifier for the contact, useful for linking with other systems.
Identifier Hash A hash value prepared for HMAC authentication related to the contact.
Email The email address of the contact.
Name The full name of the contact.
Phone Number The phone number of the contact.
Avatar Url URL pointing to an image file (jpeg, png) to be used as the contact's avatar.
Custom Attributes JSON object containing any custom attributes for the contact, allowing flexible metadata.

Output

The node outputs JSON data representing the newly created contact as returned by the ChatWoot API. This typically includes the contact’s unique ID, provided details (email, name, phone, etc.), timestamps, and any additional metadata stored. The output does not include binary data.

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 uses standard HTTP headers for JSON content negotiation.

Troubleshooting

  • Missing Inbox Identifier: Since the inbox identifier is required, omitting it will cause the request to fail. Ensure this property is set correctly.
  • Invalid API Credentials: Authentication errors may occur if the API key or base URL is incorrect or expired. Verify credentials in n8n settings.
  • Malformed Custom Attributes: The custom_attributes field expects valid JSON. Invalid JSON syntax will cause parsing errors.
  • Network Issues: Connectivity problems with the ChatWoot server will result in request failures; check network access and firewall rules.
  • API Rate Limits: Excessive requests might trigger rate limiting on the ChatWoot side; implement retries or backoff strategies if needed.

Links and References

Discussion