ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions100

Overview

This node allows you to list all agent bots associated with a specific account in ChatWoot, a customer engagement platform. It is useful for administrators or automation workflows that need to retrieve and process information about agent bots configured under a particular ChatWoot account. For example, you might use this node to audit bot configurations, synchronize bot data with other systems, or trigger actions based on the presence of certain bots.

Properties

Display Name Type Description Required
Account Id Number The numeric ID of the account Yes
  • Account Id: Enter the numeric identifier of the ChatWoot account whose agent bots you want to list.

Output

The output will be a JSON array where each item represents an agent bot associated with the specified account. Each object in the array contains details about an individual agent bot as provided by the ChatWoot API. The exact structure depends on the ChatWoot API response, but typically includes fields such as bot ID, name, status, and configuration details.

Example output:

[
  {
    "id": 123,
    "name": "SupportBot",
    "status": "active",
    // ...other bot properties
  },
  {
    "id": 124,
    "name": "SalesBot",
    "status": "inactive"
    // ...other bot properties
  }
]

Dependencies

  • External Service: Requires access to a ChatWoot instance.
  • API Credentials: You must configure the chatwootApi credentials in n8n, including the base URL (url) and authentication details.
  • n8n Configuration: Ensure the node has network access to your ChatWoot server.

Troubleshooting

  • Invalid Account Id: If you provide an incorrect or non-existent Account Id, the node may return an error or an empty result set. Double-check the Account Id value.
  • Authentication Errors: If your API credentials are missing or invalid, you may see errors related to authentication (e.g., "401 Unauthorized"). Verify your chatwootApi credential setup.
  • Connection Issues: Network problems or incorrect base URL settings can cause connection failures. Ensure the url in your credentials points to a reachable ChatWoot instance.
  • API Limitations: If your ChatWoot instance restricts API usage, you may encounter rate limiting or permission errors.

Links and References

Discussion