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 the addition of customer or user contact information into ChatWoot, enabling seamless communication and management of contacts in customer support workflows.

Typical use cases include:

  • Automatically adding new leads or customers from external systems into ChatWoot.
  • Syncing contact details collected from forms or other platforms into ChatWoot inboxes.
  • Enriching contact profiles with custom attributes for personalized messaging.

Properties

Name Meaning
Inbox Identifier The unique identifier of the inbox channel where the contact will be created.
Identifier An external identifier for the contact (e.g., user ID from another system).
Identifier Hash A hash value used 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 to associate with the contact.

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, timestamps, and any metadata set during creation.

If binary data were involved (e.g., avatar images), it would be summarized here, but this node only handles JSON contact data.

Dependencies

  • Requires an API key credential for authenticating with the ChatWoot API.
  • Needs the base URL of the ChatWoot instance configured in credentials.
  • Depends on the ChatWoot REST API being accessible and properly configured to accept contact creation requests.

Troubleshooting

  • Missing or invalid Inbox Identifier: The node requires a valid inbox identifier; ensure this is correctly provided.
  • Authentication errors: Verify that the API key credential is correct and has sufficient permissions.
  • Invalid JSON in Custom Attributes: If custom attributes are malformed JSON, the request will fail. Validate JSON syntax before input.
  • Network or API errors: Check connectivity to the ChatWoot API endpoint and confirm the service is operational.
  • Duplicate contacts: Depending on ChatWoot settings, creating a contact with an existing identifier may cause conflicts.

Links and References

Discussion