ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions100

Overview

The Get Inbox Agent Bot operation for the Inboxes resource in this custom n8n node allows you to retrieve information about the agent bot associated with a specific inbox in your ChatWoot account. This is useful when you need to programmatically access or manage the bot assigned to an inbox, such as for automation, reporting, or integration purposes.

Practical Example:
You might use this node in a workflow that monitors incoming messages and routes them based on which bot is assigned to each inbox, or to audit bot assignments across multiple inboxes in your ChatWoot instance.

Properties

Display Name Type Description
Account Id Number The numeric ID of the ChatWoot account. Required to specify which account's inbox you are querying.
Id Number The ID of the inbox whose agent bot you want to retrieve. Required.

Output

The output will be a json object containing details about the agent bot assigned to the specified inbox. While the exact structure depends on the ChatWoot API response, it typically includes fields such as:

{
  "id": 123,
  "name": "Support Bot",
  "type": "Bot",
  "inbox_id": 456,
  // ...other relevant bot properties
}
  • id: Unique identifier of the agent bot.
  • name: Name of the bot.
  • type: Type of the agent (e.g., "Bot").
  • inbox_id: The ID of the inbox this bot is assigned to.

Dependencies

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

Troubleshooting

  • Missing or Invalid Credentials:
    Error Message: "No credentials found" or authentication errors.
    Resolution: Make sure the chatwootApi credential is set up correctly in n8n and contains valid API keys and base URL.

  • Invalid Account Id or Inbox Id:
    Error Message: "Resource not found" or similar 404 errors.
    Resolution: Double-check that both the Account Id and Inbox Id are correct and exist in your ChatWoot instance.

  • Network/Connection Issues:
    Error Message: "Could not reach server" or timeout errors.
    Resolution: Ensure your n8n instance can connect to the ChatWoot API endpoint.

Links and References

Discussion