ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Overview

This node operation allows you to add one or more agents (users) to a specific inbox within an account on the ChatWoot platform. It is useful for managing team members who can access and respond to conversations in that inbox. For example, when onboarding new support agents or reassigning responsibilities, this operation helps update inbox membership dynamically.

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 which agents will be added.
User Ids A JSON array containing the IDs of users (agents) to be added to the specified inbox.

Output

The node outputs JSON data representing the result of the API call to add agents to the inbox. This typically includes confirmation details such as updated inbox membership or success status. There is no binary output.

Dependencies

  • Requires an API key credential for authenticating with the ChatWoot API.
  • The base URL for the ChatWoot instance must be configured in the node credentials.
  • The node uses the ChatWoot REST API endpoint related to inbox management.

Troubleshooting

  • Invalid Account or Inbox ID: Ensure the provided account and inbox IDs exist and are correct.
  • User IDs Format: The user IDs must be provided as a valid JSON array; malformed JSON will cause errors.
  • Authentication Errors: Verify that the API key credential is valid and has sufficient permissions.
  • API Endpoint Issues: Network connectivity or incorrect base URL configuration may lead to request failures.

Links and References

Discussion