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 bots.
  • Integrating 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 that owns the inbox.
Id The numeric ID of the inbox for which the agent bot information is requested.

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, status, and any metadata provided by the ChatWoot API for that inbox agent bot.

No binary data output is expected from this operation.

Dependencies

  • Requires an API key credential for authenticating with the ChatWoot API.
  • The node expects the base URL of the ChatWoot instance to be configured in the credentials.
  • Network connectivity to the ChatWoot API endpoint is necessary.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Providing incorrect account or inbox IDs may result in "not found" errors.
    • Network issues can lead to timeouts or connection errors.
  • Error messages and resolutions:

    • 401 Unauthorized: Check that the API key credential is correctly set and has sufficient permissions.
    • 404 Not Found: Verify that the account ID and inbox ID are correct and exist in the ChatWoot system.
    • Timeout or network error: Ensure stable internet connection and that the ChatWoot server URL is reachable.

Links and References

Discussion