ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Overview

This node interacts with the ChatWoot API to retrieve information about an agent bot configured for a specific inbox within a ChatWoot account. It is useful when you want to programmatically access details of the automated agent (bot) assigned to handle conversations in a particular inbox, such as fetching its configuration or status.

Practical examples include:

  • Automating monitoring or reporting on inbox agent bots.
  • Integrating ChatWoot inbox bot details into dashboards or other systems.
  • Triggering workflows based on the presence or properties of an inbox agent bot.

Properties

Name Meaning
Account Id The numeric ID of the ChatWoot account.
Id The numeric ID of the inbox whose agent bot you want to retrieve.

Output

The node outputs JSON data representing the agent bot associated with the specified inbox. This typically includes details such as the bot's configuration, identifiers, and status within the ChatWoot system.

No binary data output is produced by this node.

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 provided account and inbox IDs being valid.

Troubleshooting

  • Invalid Credentials: If authentication fails, verify that the API key and base URL are correctly set in the node credentials.
  • Resource Not Found: Errors indicating the inbox or agent bot was not found usually mean the provided account ID or inbox ID is incorrect or does not exist.
  • API Rate Limits: If requests are throttled, consider implementing retry logic or reducing request frequency.
  • Network Issues: Ensure the ChatWoot server is reachable from the n8n environment.

Links and References

Discussion