ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Contacts → Contact Create

AI-generated

Overview

This node allows you to create a new contact in the ChatWoot system. It is useful for automating the addition of contacts into your ChatWoot account, such as when integrating with CRM systems, lead capture forms, or customer support workflows. For example, when a new user signs up on your website, you can automatically create a corresponding contact in ChatWoot to start tracking conversations and interactions.

Properties

Name Meaning
Account Id The numeric ID of the ChatWoot account where the contact will be created (required).
Inbox Id The numeric ID of the inbox within the account where the contact should be associated (required).
Name The name of the contact.
Email The email address of the contact.
Phone Number The phone number of the contact.
Avatar Binary data representing the avatar image of the contact, sent as form data.
Avatar Url URL pointing to an image file (jpeg, png) to use as the contact's avatar.
Identifier A unique identifier for the contact in an external system, useful for synchronization.
Custom Attributes A JSON object containing custom key-value pairs to store additional attributes about the contact, e.g., {"type":"customer", "age":30}.

Output

The node outputs the response from the ChatWoot API after creating the contact. This typically includes a JSON object representing the newly created contact with all its details as stored in ChatWoot. If an avatar image is provided as binary data, it is uploaded accordingly but not outputted separately by the node.

Dependencies

  • Requires an active ChatWoot account.
  • Requires an API authentication token configured in the node credentials to authorize requests to the ChatWoot API.
  • The base URL of the ChatWoot instance must be set in the credentials configuration.

Troubleshooting

  • Missing required fields: Ensure that both Account Id and Inbox Id are provided; these are mandatory.
  • Invalid API credentials: Authentication errors occur if the API token or base URL is incorrect or missing.
  • Avatar upload issues: When sending avatar images as binary data, ensure the data is correctly formatted and accessible.
  • Malformed custom attributes: The custom_attributes field expects valid JSON; invalid JSON strings will cause errors.
  • Network or API errors: Check connectivity and ChatWoot service status if requests fail unexpectedly.

Links and References

Discussion