ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Overview

This node integrates with the ChatWoot API to update the agent bot assigned to a specific inbox within an account. It is useful in scenarios where you need to programmatically change or assign an automated agent (bot) to handle conversations in a particular inbox, such as automating customer support routing or updating bot configurations dynamically.

Practical examples include:

  • Automatically switching the agent bot for an inbox based on time of day or workload.
  • Updating inbox settings during onboarding or configuration changes without manual intervention.

Properties

Name Meaning
Account Id The numeric ID of the ChatWoot account that owns the inbox.
Id The numeric ID of the inbox whose agent bot you want to update.
Agent Bot The numeric ID of the agent bot to assign to the specified inbox.

Output

The node outputs JSON data representing the updated inbox resource after the agent bot has been changed. This typically includes details about the inbox and its new agent bot assignment.

No binary data output is involved.

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 depends on the ChatWoot REST API being accessible and the user having appropriate permissions to update inboxes.

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 IDs before running the node.
  • Agent Bot ID Not Found: Providing an invalid or non-existent agent bot ID will cause the update to fail. Ensure the agent bot ID is valid within the account.
  • Authentication Errors: Missing or incorrect API credentials will result in authentication failures. Confirm that the API key and base URL are correctly set.
  • Permission Denied: The API user must have permission to update inboxes; otherwise, the request will be rejected.
  • Network Issues: Connectivity problems to the ChatWoot server will cause the node to fail. Check network access and server status.

Links and References

Discussion