ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions100

Overview

This node updates an existing Agent Bot in ChatWoot via its API. It is useful when you need to programmatically modify the details of a bot, such as its name, description, or webhook URL, directly from your n8n workflows. Common scenarios include automating bot management, synchronizing bot configurations across environments, or updating bot endpoints after deployment changes.

Example use cases:

  • Automatically update a bot's webhook URL after deploying a new backend.
  • Change the display name or description of a bot based on workflow logic.
  • Integrate with other systems to keep bot metadata up-to-date.

Properties

Display Name Type Description
Id Number The ID of the agent bot to be updated (required).
Name String The name of the agent bot.
Description String The description about the agent bot.
Outgoing Url String The webhook URL for the bot.

Output

The output will contain the JSON response from the ChatWoot API after updating the specified Agent Bot. This typically includes the updated properties of the bot, such as its id, name, description, outgoing_url, and possibly other metadata fields provided by the API.

{
  "id": 123,
  "name": "Updated Bot Name",
  "description": "New description",
  "outgoing_url": "https://example.com/webhook",
  // ...other fields returned by ChatWoot API
}

Dependencies

  • External Service: Requires access to a ChatWoot instance with API enabled.
  • API Key: Needs valid ChatWoot API credentials configured in n8n under the credential type chatwootApi.
  • Environment Variable: The base URL for ChatWoot must be set in the credentials (url field).

Troubleshooting

  • Missing or Invalid Credentials:
    Error: "401 Unauthorized" or similar.
    Resolution: Ensure that the correct ChatWoot API credentials are configured in n8n.

  • Invalid Agent Bot ID:
    Error: "404 Not Found" or similar.
    Resolution: Verify that the provided Id corresponds to an existing Agent Bot in ChatWoot.

  • Required Fields Missing:
    Error: "400 Bad Request" or similar.
    Resolution: Make sure all required fields, especially Id, are provided and valid.

  • Network/Connection Issues:
    Error: "ENOTFOUND", "ECONNREFUSED", etc.
    Resolution: Check network connectivity and ensure the ChatWoot instance is reachable from n8n.

Links and References

Discussion