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 or leads into your ChatWoot system directly from other tools or triggers in your automation pipeline.

Typical use cases include:

  • Automatically creating contacts when a new user signs up on your website.
  • Importing contacts from external CRM systems.
  • Enriching customer data by adding custom attributes during contact creation.

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's identifier.
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 additional custom attributes for the contact.

Output

The node outputs JSON data representing the newly created contact as returned by the ChatWoot API. This typically includes all the contact details stored in ChatWoot, such as identifiers, contact info, and any custom attributes.

If the API supports it, binary data output is not expected for this operation since it deals with contact metadata only.

Dependencies

  • Requires an API key credential for authenticating with the ChatWoot API.
  • The base URL of the ChatWoot instance must be configured in the credentials.
  • The node uses standard HTTP headers for JSON content type and expects JSON responses.

Troubleshooting

  • Missing Inbox Identifier: The inbox identifier is mandatory; ensure it is provided to avoid request failures.
  • Invalid JSON in Custom Attributes: If the custom attributes field contains malformed JSON, the API call will fail. Validate JSON syntax before sending.
  • Authentication Errors: Verify that the API key credential is correctly set up and has sufficient permissions.
  • Network Issues: Check connectivity to the ChatWoot server URL configured in credentials.
  • API Response Errors: Inspect error messages returned by the API for issues like duplicate contacts or invalid fields.

Links and References

Discussion