ChatWoot

Overview

This node allows you to create an integration hook in ChatWoot via its API. An integration hook is typically used to connect external applications or services (such as CRMs, bots, or notification systems) with your ChatWoot account, enabling automated workflows and data exchange. Common scenarios include setting up webhooks for incoming messages, automating ticket creation, or integrating third-party tools with specific inboxes or apps within ChatWoot.

Example use cases:

• Automatically forwarding new conversations from a specific inbox to another system.
• Integrating a chatbot platform with a ChatWoot app.
• Setting up custom notifications or triggers when certain events occur in ChatWoot.

Properties

Output

The output will be a JSON object representing the newly created integration hook as returned by the ChatWoot API. The structure typically includes details such as the hook's ID, associated app or inbox, configuration settings, and status. The exact fields depend on the ChatWoot API response but may look like:

{
  "id": 123,
  "account_id": 456,
  "app_id": "abc123",
  "inbox_id": "inbox789",
  "settings": {
    // ...integration-specific settings...
  },
  "status": "active"
}

Note: The node does not output binary data.

Dependencies

• External Service: Requires access to a ChatWoot instance with API enabled.
• API Credentials: You must configure n8n credentials named chatwootApi, including at least the base URL (url) and likely an API key or token.
• n8n Configuration: Ensure that the ChatWoot node is properly installed and that the credentials are set up in your n8n instance.

Troubleshooting

Common Issues:

• Invalid Account/App/Inbox IDs: Supplying incorrect or non-existent IDs will result in API errors.
• Malformed Settings JSON: If the "Settings" property is not valid JSON, the request will fail.
• Missing Credentials: If the required chatwootApi credentials are not configured, the node will throw an authentication error.
• Insufficient Permissions: The API user must have permission to create integration hooks.

Error Messages & Resolutions:

• "Invalid JSON in 'Settings'": Double-check that the value entered is valid JSON.
• "401 Unauthorized": Verify that your API credentials are correct and have sufficient permissions.
• "404 Not Found": Ensure that the provided Account Id, App Id, or Inbox Id exists in your ChatWoot instance.

Links and References

• ChatWoot API Documentation
• n8n Documentation: Creating Custom Nodes
• ChatWoot Integrations Guide