ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions100

Overview

This node allows you to create a new user for a specific account in ChatWoot, a customer engagement platform. It is useful when you want to automate the process of adding users (such as agents or administrators) to an account within your ChatWoot workspace. For example, you might use this node in workflows that onboard new team members or synchronize user data from another system into ChatWoot.

Properties

Display Name Type Description
Account Id Number The numeric ID of the account where the user will be added. This is required.
User Id Number The ID of the user to add to the account. This is required.
Role String Specifies whether the user is an administrator or agent. This is required.

Output

The output will contain the JSON response from the ChatWoot API after creating the account user. Typically, this includes details about the newly created account-user relationship, such as IDs, role, and possibly timestamps or status information.

Dependencies

  • External Service: Requires access to a ChatWoot instance.
  • API Credentials: You must configure the chatwootApi credential in n8n, which should include the base URL and authentication details for your ChatWoot environment.

Troubleshooting

  • Missing or Invalid Credentials: If the chatwootApi credential is not set up correctly, the node will fail to connect to ChatWoot. Ensure the credentials are valid and have sufficient permissions.
  • Invalid Account or User ID: Providing non-existent or incorrect IDs will result in errors from the ChatWoot API, such as "Account not found" or "User not found."
  • Role Value Issues: Supplying an invalid value for the "Role" property may cause the API to reject the request. Use only supported roles like administrator or agent.

Links and References

Discussion