ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions100

Overview

This node allows you to remove one or more agents (users) from a specific inbox within a ChatWoot account. It is useful for managing team assignments and ensuring that only the appropriate users have access to particular inboxes. For example, if an agent leaves your support team or changes roles, you can use this operation to revoke their access to certain inboxes.

Practical scenarios:

  • Offboarding agents from customer support inboxes.
  • Reassigning inbox responsibilities by removing old user associations.
  • Automating user management in ChatWoot via n8n workflows.

Properties

Display Name Type Description
Account Id Number The numeric ID of the ChatWoot account.
Inbox Id String The ID of the inbox from which agents will be removed.
User Ids JSON An array of user IDs to be deleted from the specified inbox.

Output

The output will contain a json field reflecting the response from the ChatWoot API after attempting to remove the specified users from the inbox. The structure typically includes status information and may include details about the updated inbox or errors encountered.

Dependencies

  • External Service: Requires access to a ChatWoot instance.
  • API Credentials: You must configure the chatwootApi credential in n8n, including the base URL (url) for your ChatWoot installation.
  • n8n Configuration: Ensure the node has access to the necessary credentials and network connectivity to reach your ChatWoot server.

Troubleshooting

Common Issues:

  • Invalid Account or Inbox ID: If the provided Account Id or Inbox Id does not exist, the operation will fail.
  • Malformed User Ids: The User Ids property must be a valid JSON array of user IDs. Supplying invalid JSON or non-existent user IDs will result in errors.
  • Authentication Errors: Missing or incorrect API credentials will prevent the node from connecting to ChatWoot.

Error Messages & Resolutions:

  • "Invalid credentials": Check your chatwootApi credential configuration in n8n.
  • "Inbox not found" or "Account not found": Verify the Account Id and Inbox Id values.
  • "Invalid user_ids format": Ensure the User Ids input is a properly formatted JSON array (e.g., [1,2,3]).

Links and References

Discussion