ChatWoot

Overview

This node allows you to create a new Agent Bot in ChatWoot via its API. It is useful for automating the setup of bot agents that can interact with customers or users within your ChatWoot instance. Typical scenarios include onboarding new bots for automated customer support, integrating external services as bots, or programmatically managing your ChatWoot environment.

Example use cases:

• Automatically creating a bot when a new service is launched.
• Integrating a webhook-based bot for real-time notifications.
• Setting up multiple bots for different departments or workflows.

Properties

Output

The node returns a json object representing the newly created Agent Bot. The structure typically includes details such as the bot's ID, name, description, and outgoing URL, as provided by the ChatWoot API response.

Example output:

{
  "id": 123,
  "name": "SupportBot",
  "description": "Handles basic support queries",
  "outgoing_url": "https://example.com/webhook",
  // ...other fields returned by ChatWoot
}

Dependencies

• External Service: Requires access to a ChatWoot instance with API enabled.
• API Key: You must provide valid ChatWoot API credentials (chatwootApi) in n8n.
• n8n Configuration: The base URL for ChatWoot should be set in the credentials.

Troubleshooting

• Invalid Credentials: If the API key or URL is incorrect, you may receive authentication errors. Double-check your ChatWoot API credentials in n8n.
• Missing Required Fields: If any required property (Name, Outgoing Url) is missing, the API may return a validation error.
• Network Issues: Ensure that n8n can reach your ChatWoot instance (firewall, VPN, etc.).
• Common Error Messages:
  • "401 Unauthorized": Check your API key and permissions.
  • "400 Bad Request": Verify all required fields are filled and correctly formatted.

Links and References

• ChatWoot API Documentation
• n8n Documentation: Credentials
• n8n Community Support