ChatWootInstall

Overview

This node operation allows you to create a webhook subscription for an account in the ChatWoot system. By creating a webhook, you specify a URL where event notifications will be sent whenever subscribed events occur. This is useful for integrating ChatWoot with other systems or services that need to react to real-time events such as new messages, conversations, or status changes.

Common scenarios include:

• Automatically syncing ChatWoot events with external CRMs or databases.
• Triggering workflows or alerts in other applications when specific ChatWoot events happen.
• Logging or monitoring ChatWoot activity externally.

Example: You want to receive notifications on your server every time a new conversation is created in a particular ChatWoot account. You create a webhook with the URL of your server and subscribe to the "conversation_created" event.

Properties

Output

The node outputs JSON data representing the response from the ChatWoot API after creating the webhook. This typically includes details about the newly created webhook such as its ID, subscribed events, target URL, and status.

If the API supports it, the output may also contain metadata or confirmation fields indicating successful creation.

No binary data output is expected from this operation.

Dependencies

• Requires an active connection to the ChatWoot API.
• Needs an API authentication token or key configured in the node credentials to authorize requests.
• The base URL for the ChatWoot instance must be set in the credentials configuration.

Troubleshooting

• Invalid Account Id: If the provided account ID does not exist or is incorrect, the API will return an error. Verify the account ID before running the node.
• Invalid URL: Ensure the URL is correctly formatted and publicly accessible; otherwise, webhook delivery will fail.
• Subscription Format Errors: The subscriptions property must be valid JSON representing an array of event names. Malformed JSON will cause request failures.
• Authentication Errors: Missing or invalid API credentials will prevent the webhook from being created. Check credential setup.
• API Rate Limits: Excessive webhook creation attempts might hit rate limits imposed by ChatWoot.

Links and References

• ChatWoot Webhooks Documentation (for detailed event types and webhook management)
• Webhook Concepts (general overview of webhooks)