ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions100

Overview

This node allows you to create a new user in ChatWoot via its API. It is useful for automating user onboarding, syncing users from other systems, or programmatically managing your ChatWoot user base. For example, you could use this node to automatically add new customers to ChatWoot when they sign up on your website.

Properties

Display Name Type Description
Name String Name of the user.
Email String Email of the user.
Password String Password must contain uppercase, lowercase letters, number and a special character.
Custom Attributes JSON Custom attributes you want to associate with the user (as a JSON object).

Output

The output will be a json object containing the details of the newly created user as returned by the ChatWoot API. The structure typically includes fields such as user ID, name, email, and any custom attributes provided. The exact structure depends on the ChatWoot API response.

Dependencies

  • External Service: Requires access to a ChatWoot instance.
  • API Credentials: You must configure the chatwootApi credentials in n8n, including the base URL (url) and authentication details.
  • n8n Configuration: Ensure that the ChatWoot node is properly installed and configured within your n8n environment.

Troubleshooting

  • Missing or Invalid Credentials: If the chatwootApi credentials are not set or incorrect, the node will fail to connect to ChatWoot. Double-check your API key and base URL.
  • Invalid Input Data: If required fields like Name, Email, or Password are missing or do not meet validation requirements (e.g., password complexity), the API may return an error.
  • Malformed Custom Attributes: Ensure that the "Custom Attributes" field contains valid JSON. Invalid JSON will cause errors.
  • Common Error Messages:
    • 401 Unauthorized: Check your API credentials.
    • 400 Bad Request: Review input data for missing or invalid fields.
    • 422 Unprocessable Entity: Typically indicates validation errors, such as an already registered email or weak password.

Links and References

Discussion