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.
Inbox Id The numeric ID of the inbox within the account to associate the contact with.
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 purposes.
Custom Attributes A JSON object containing custom key-value pairs to store additional attributes about 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 ID, associated account and inbox IDs, name, email, phone number, avatar information, identifier, and any custom attributes set. If an avatar image is sent as binary data, it is included in the request but not outputted separately.

Dependencies

  • Requires an active ChatWoot account with API access.
  • Needs an API authentication token configured in n8n credentials to authorize requests.
  • The base URL of the ChatWoot instance must be provided in the credential configuration.

Troubleshooting

  • Missing required fields: Ensure that Account Id and Inbox Id are provided and valid numeric values; 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 as binary data, ensure the data is correctly formatted and the content type is supported.
  • Malformed JSON in Custom Attributes: The custom_attributes field expects valid JSON; invalid JSON will cause parsing errors.
  • Network or API errors: Check connectivity and API rate limits if requests fail unexpectedly.

Links and References

Discussion