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 their status and permissions are up to date without manual intervention in the ChatWoot dashboard.

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 details such as id, role, availability, and other metadata. There is no binary output.

Dependencies

• Requires an API key credential for authenticating with the ChatWoot API.
• Needs the base URL of the ChatWoot instance configured in the credentials.
• Depends on the ChatWoot REST API being accessible and operational.

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.
• Authentication Errors: Ensure the API key credential is valid and has sufficient permissions.
• Invalid Property Values: Passing unsupported values for role or availability may cause request failures. Use only the allowed options.
• Network Issues: Connectivity problems to the ChatWoot server will prevent updates; check network and endpoint accessibility.

Links and References

• ChatWoot API Documentation - Official API docs for reference on agent management endpoints.