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 data 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 to retrieve the agent bot information.

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 base URL for the ChatWoot instance must be configured in the credentials.
  • The node depends on the @devlikeapro/n8n-openapi-node package for OpenAPI integration.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication errors.
    • Providing incorrect account or inbox IDs may result in "not found" errors.
    • Network connectivity problems can prevent successful API calls.
  • Error messages:

    • Authentication failures: Verify that the API key and base URL are correctly set in the credentials.
    • Resource not found: Confirm that the account ID and inbox ID exist and are correct.
    • Unexpected API responses: Check if the ChatWoot API endpoint has changed or if there are permission restrictions.

Links and References

Discussion