ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Overview

This node interacts with the ChatWoot API to update the list of agents assigned to a specific inbox within an account. It allows users to add or modify which agents (users) have access to handle conversations in that inbox. This is useful for managing team assignments dynamically, ensuring the right agents are linked to the correct communication channels.

Practical examples:

  • Adding new support agents to a customer service inbox after hiring.
  • Updating agent assignments when teams are reorganized.
  • Automating inbox-agent mappings based on business rules or schedules.

Properties

Name Meaning
Account Id The numeric ID of the ChatWoot account where the inbox exists.
Inbox Id The unique identifier of the inbox to update.
User Ids A JSON array containing the IDs of users (agents) to be added to the inbox.

Output

The node outputs JSON data representing the response from the ChatWoot API after updating the agents in the specified inbox. This typically includes confirmation of the updated inbox details and the list of assigned agents.

If the API supports it, binary data output is not expected for this operation.

Dependencies

  • Requires an API key credential for authenticating with the ChatWoot API.
  • The base URL for the ChatWoot instance must be configured in the credentials.
  • The node depends on the @devlikeapro/n8n-openapi-node package for OpenAPI integration.

Troubleshooting

  • Invalid Account or Inbox ID: Ensure the provided Account Id and Inbox Id exist and are correct; otherwise, the API will return errors.
  • Malformed User Ids JSON: The User Ids property expects a valid JSON array. Invalid JSON will cause parsing errors.
  • Authentication Errors: Verify that the API key credential is valid and has sufficient permissions.
  • Network Issues: Check connectivity to the ChatWoot instance URL.

Common error messages might include:

  • "Unauthorized" or "Authentication failed": Check API key validity.
  • "Inbox not found": Confirm the Inbox Id is correct and belongs to the specified account.
  • "Invalid request body": Validate the JSON format of user IDs.

Links and References

Discussion