ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions100

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 team members dynamically, ensuring that their permissions and statuses reflect their current responsibilities and availability.

Practical examples include:

  • Changing an agent's role from "agent" to "administrator" to grant them higher privileges.
  • Updating an agent’s availability to "busy" during peak hours to prevent new assignments.
  • Configuring auto offline settings to automatically mark agents as offline when inactive.

Properties

Name Meaning
Account Id The numeric ID of the account where the agent exists.
Id The unique identifier of the agent to be updated.
Role The role assigned to the agent; options are: Agent or Administrator.
Availability The current availability status of the agent; options are: Available, Busy, Offline.
Auto Offline Boolean flag indicating if the agent should automatically be set to offline when away.

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 confirming the successful update.

No binary data output is involved in this operation.

Dependencies

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

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: Missing or invalid API credentials will cause authorization failures. Ensure the API key/token is correctly set up.
  • Invalid Property Values: Providing unsupported values for role or availability may result in validation errors. Use only the allowed options.
  • Network Issues: Connectivity problems with the ChatWoot server can cause request timeouts or failures. Check network access and endpoint availability.

Links and References

Discussion