ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

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 platforms. 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 to associate the contact with (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.
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 contact.

Output

The node outputs JSON data representing the newly created contact as returned by the ChatWoot API. This typically includes the contact's ID, associated account and inbox IDs, name, email, phone number, avatar information, identifier, and any custom attributes set. If binary data is used for the avatar, it is sent as form data but not outputted as binary in the node’s response.

Dependencies

  • Requires an API key credential for authenticating with the ChatWoot API.
  • The base URL for the ChatWoot instance must be configured in the credentials.
  • The node uses the ChatWoot REST API to perform the contact creation.

Troubleshooting

  • Missing required fields: Ensure that both Account Id and Inbox Id are provided; these are mandatory.
  • Invalid API credentials or URL: Verify that the API key and base URL are correctly set in the node credentials.
  • Avatar upload issues: When sending avatar as binary data, ensure the binary property is correctly referenced and contains valid image data.
  • Malformed JSON in Custom Attributes: The custom attributes field expects a valid JSON string; invalid JSON will cause errors.
  • API rate limits or network errors: These may cause request failures; check connectivity and API usage limits.

Links and References

Discussion