ChatWootInstall

Overview

This node operation updates an existing agent within a specified account in the ChatWoot system. It allows modifying key attributes of the agent such as their role (agent or administrator), availability status, and whether they automatically go offline when away. This is useful for managing support team members dynamically, ensuring that their permissions and statuses reflect current operational needs.

Practical examples include:

• Changing an agent’s role from "agent" to "administrator" to grant higher privileges.
• Updating an agent’s availability to "busy" during peak hours.
• Enabling or disabling automatic offline status based on agent activity.

Properties

Output

The node outputs JSON data representing the updated agent object as returned by the ChatWoot API. This typically includes the agent’s updated properties such as id, role, availability, and auto offline status.

If binary data were involved (e.g., profile images), it would be summarized here, but this operation deals only with JSON data.

Dependencies

• Requires an active connection to the ChatWoot API.
• Needs an API authentication token configured in the node credentials.
• The base URL for the ChatWoot instance must be set in the credentials.

Troubleshooting

• Invalid Account or Agent ID: If the provided account or agent ID does not exist, the API will return an error. Verify IDs before running the node.
• Insufficient Permissions: Attempting to update an agent without proper API credentials or permissions may result in authorization errors.
• Invalid Property Values: Providing unsupported values for role or availability will cause validation errors. Use only the allowed options.
• Network Issues: Connectivity problems with the ChatWoot server can cause request failures. Check network and endpoint accessibility.

Links and References

• ChatWoot API Documentation
• ChatWoot Official Website