ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Overview

This node integrates with the ChatWoot API to create a new Account Agent Bot within a specified account. It is useful for automating the setup of chatbots that can interact with customers on behalf of an account, enabling automated responses or workflows in customer support scenarios.

Practical examples include:

  • Automatically provisioning a new chatbot agent when onboarding a new client.
  • Creating bots that handle specific tasks such as answering FAQs or routing conversations.
  • Setting up webhook URLs for real-time interaction between the bot and external services.

Properties

Name Meaning
Account Id The numeric ID of the account where the agent bot will be created.
Name The name assigned to the new agent bot.
Description A textual description providing details about the agent bot's purpose or functionality.
Outgoing Url The webhook URL that the bot will use to send outgoing messages or events.

Output

The node outputs JSON data representing the newly created Account Agent Bot as returned by the ChatWoot API. This typically includes details such as the bot's unique identifier, name, description, associated account ID, and webhook URL.

If the API supports it, binary data output is not indicated or expected for 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 node credentials.
  • The node depends on the @devlikeapro/n8n-openapi-node package for OpenAPI integration.

Troubleshooting

  • Invalid Account Id: Ensure the provided Account Id exists and is accessible with the given API credentials.
  • Missing Required Fields: The Account Id is mandatory; missing it will cause errors.
  • Webhook URL Issues: Verify that the Outgoing Url is a valid and reachable webhook endpoint.
  • Authentication Errors: Check that the API key credential is correctly set and has sufficient permissions.
  • API Rate Limits: If requests fail intermittently, consider API rate limits imposed by ChatWoot.

Common error messages may include HTTP 400 (bad request) for invalid input, 401 (unauthorized) for authentication issues, or 404 (not found) if the account does not exist.

Links and References

Discussion