ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions100

Overview

This node allows you to add one or more agents (users) to a specific inbox in ChatWoot, a customer support platform. It is useful for automating team management tasks, such as onboarding new support agents to particular inboxes or updating agent assignments based on workflow triggers.

Example scenarios:

  • Automatically assign new support staff to relevant inboxes when they join your organization.
  • Batch update agent assignments across multiple inboxes as part of a scheduled workflow.
  • Integrate with HR or onboarding systems to streamline agent provisioning in ChatWoot.

Properties

Display Name Type Description
Account Id Number The numeric ID of the ChatWoot account.
Inbox Id String The ID of the inbox to which agents will be added.
User Ids JSON An array of user IDs representing agents to add to the inbox. Example: [123, 456]

Output

The output will contain a json field reflecting the response from the ChatWoot API after attempting to add the specified agents to the inbox. The structure typically includes information about the updated inbox and its assigned agents, but the exact fields depend on the ChatWoot API's response.

Dependencies

  • External Service: Requires access to a ChatWoot instance.
  • API Credentials: You must configure the chatwootApi credential in n8n, including the base URL (url) and authentication details.
  • n8n Configuration: Ensure that the node has network access to 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 valid JSON (an array of numbers). Invalid JSON will cause errors.
    • Authentication Errors: Missing or incorrect API credentials will result in authorization failures.
    • Network Issues: If n8n cannot reach the ChatWoot server, the request will fail.
  • Error Messages & Resolutions:

    • "Invalid JSON in 'User Ids'": Ensure the value is a properly formatted JSON array, e.g., [123, 456].
    • "401 Unauthorized": Check your ChatWoot API credentials in n8n.
    • "404 Not Found": Verify that the Account Id and Inbox Id are correct and exist in your ChatWoot instance.

Links and References

Discussion