ChatWootInstall

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 staff or reassigning responsibilities, this operation helps update inbox membership dynamically.

Properties

Output

The output contains a JSON object representing the result of the API call to add agents to the inbox. This typically includes confirmation details such as the updated list of agents or status messages from the ChatWoot API. There is no binary data output 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 node credentials.
• The node uses the ChatWoot REST API endpoint related to inbox management.

Troubleshooting

• Invalid Account or Inbox ID: If the provided account or inbox ID does not exist or is incorrect, the API will return an error. Verify these IDs in your ChatWoot dashboard.
• User IDs Format: The user_ids property must be a valid JSON array of user IDs. Malformed JSON or invalid user IDs will cause the request to fail.
• Authentication Errors: Ensure the API key credential is valid and has sufficient permissions to modify inbox memberships.
• Network Issues: Connectivity problems or incorrect base URL configuration may prevent successful API calls.

Links and References

• ChatWoot API Documentation
• Managing Inboxes in ChatWoot