Webhooks

Learn how to subscribe to Kadoa webhook events and receive notifications about data changes.

Kadoa webhooks allow you to receive notifications when data changes occur in your workflows. By subscribing to webhook events, you can automate actions based on these notifications.

API Configuration

Step 1: Create a Webhook Channel

First, create a webhook channel by making a POST request to /v5/notifications/channels:

View full API reference →

Request

// POST /v5/notifications/channels
{
  "channelType": "WEBHOOK",
  "name": "Data Changes Webhook",
  "config": {
    "webhookUrl": "https://your-endpoint.com/webhook",
    "httpMethod": "POST",
    "auth": {
      "type": "bearer",
      "token": "your-secret-token"
    }
  }
}

The response will include an id in the channel object that you’ll need for the next step.

Step 2: Subscribe to Data Changes

Once you have the channel ID, subscribe to data changes events by making a POST request to /v5/notifications/settings:

View full API reference →

Request

// POST /v5/notifications/settings
{
  "workflowId": "<your-workflow-id>",
  "eventType": "workflow_data_change",
  "eventConfiguration": {},
  "enabled": true,
  "channelIds": ["<channel-id-from-step-1>"]
}

UI Configuration

You can also configure webhooks through the UI:

1. Add a webhook channel via the notifications tab in the left sidebar or notifications tab in a workflow

2. Subscribe to events by selecting the webhook channel in workspace settings or workflow-specific settings

Handling Data Change Events

When data changes occur, Kadoa sends a POST request to your webhook URL with this payload structure:

Webhook Payload

{
  "id": "change-id",
  "workflowId": "workflow-id",
  "data": [...],
  "differences": [...],
  "url": "https://monitored-page.com",
  "createdAt": "2025-01-09T10:00:00Z",
  "metadata": {
    "workflowName": "My Workflow",
    "tags": ["tag1", "tag2"]
  }
}

Ensure your webhook endpoint is accessible