ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Overview

This node operation updates an existing Account Agent Bot within a specified account. It allows users to modify properties such as the bot's name, description, and webhook URL. This is useful in scenarios where you need to maintain or improve your automated agent bots by changing their metadata or integration endpoints without recreating them from scratch.

Practical examples include:

  • Updating the webhook URL when the endpoint handling bot events changes.
  • Renaming the bot to reflect new branding or functionality.
  • Adding or modifying the description to provide better context for team members.

Properties

Name Meaning
Account Id The numeric ID of the account to which the agent bot belongs.
Id The unique identifier of the agent bot that needs to be updated.
Name The new name for the agent bot.
Description A textual description providing details about the agent bot.
Outgoing Url The webhook URL where the bot will send outgoing requests or notifications.

Output

The node outputs JSON data representing the updated state of the Account Agent Bot after the update operation completes successfully. This typically includes the bot's current properties such as its ID, name, description, and webhook URL reflecting any changes made.

If the node supports binary data output (not indicated here), it would generally represent files or media related to the bot, but this operation focuses on JSON metadata updates only.

Dependencies

  • Requires an API key credential for authenticating with the ChatWoot API service.
  • Needs the base URL of the ChatWoot instance configured in the credentials.
  • Relies on the ChatWoot REST API to perform the update operation on the specified agent bot.

Troubleshooting

  • Invalid Account Id or Bot Id: If the provided IDs do not exist or are incorrect, the API will likely return a "Not Found" error. Verify the IDs before running the node.
  • Authentication Errors: Missing or invalid API credentials will cause authentication failures. Ensure the API key and base URL are correctly set in the node credentials.
  • Invalid Webhook URL: Providing an improperly formatted URL for the outgoing webhook may result in validation errors. Use a valid URL format.
  • Empty Required Fields: The Account Id and Bot Id are mandatory; omitting them will prevent the update from executing.
  • API Rate Limits or Downtime: If the ChatWoot API is unreachable or rate-limited, the node will fail. Check network connectivity and API status.

Links and References

Discussion