Webhooks

import { KadoaClient } from "@kadoa/node-sdk";

const client = new KadoaClient({ apiKey: "YOUR_API_KEY" });

await client.notification.setupForWorkflow({
  workflowId: "YOUR_WORKFLOW_ID",
  events: ["workflow_data_change"],
  channels: {
    WEBHOOK: {
      name: "my-webhook",
      webhookUrl: "https://api.example.com/webhooks/kadoa",
      httpMethod: "POST",
    },
  },
});

from kadoa_sdk import KadoaClient, KadoaClientConfig
from kadoa_sdk.notifications import SetupWorkflowNotificationSettingsRequest

client = KadoaClient(KadoaClientConfig(api_key="YOUR_API_KEY"))

client.notification.setup_for_workflow(
    SetupWorkflowNotificationSettingsRequest(
        workflow_id="YOUR_WORKFLOW_ID",
        events=["workflow_data_change"],
        channels={
            "WEBHOOK": {
                "name": "my-webhook",
                "webhookUrl": "https://api.example.com/webhooks/kadoa",
                "httpMethod": "POST",
            }
        },
    )
)

{
  "eventType": "workflow_data_change",
  "timestamp": "2025-01-15T10:30:00Z",
  "data": {
    "id": "change_123",
    "workflowId": "wf_123",
    "data": [
      { "id": "record-1", "name": "Product A", "price": 29.99 }
    ],
    "differences": [
      {
        "type": "changed",
        "fields": [
          { "key": "price", "value": 29.99, "previousValue": 24.99 }
        ]
      },
      {
        "type": "added",
        "fields": [
          { "key": "id", "value": "record-2" },
          { "key": "name", "value": "New Product" }
        ]
      }
    ],
    "url": "https://monitored-page.com",
    "createdAt": "2025-01-15T10:30:00Z",
    "metadata": {
      "workflowName": "Product Monitor",
      "tags": ["pricing"]
    }
  }
}

{
  "eventType": "workflow_finished",
  "timestamp": "2025-01-15T10:30:00Z",
  "data": {
    "id": "wf_123",
    "jobId": "job_456",
    "source": "scheduler"
  }
}

{
  "eventType": "workflow_failed",
  "timestamp": "2025-01-15T10:30:00Z",
  "data": {
    "workflowId": "wf_123",
    "workflowName": "Product Monitor",
    "source": "Product Monitor",
    "sourceUrl": "https://monitored-page.com",
    "url": "https://monitored-page.com",
    "reason": "Access blocked by bot protection",
    "action": "No action needed. We'll email you when the workflow recovers."
  }
}

{
  "eventType": "workflow_recovered",
  "timestamp": "2025-01-15T10:45:00Z",
  "data": {
    "workflowId": "wf_123",
    "workflowName": "Product Monitor",
    "source": "Product Monitor",
    "sourceUrl": "https://monitored-page.com",
    "url": "https://monitored-page.com"
  }
}

{
  "eventType": "workflow_validation_anomaly_change",
  "timestamp": "2025-01-15T10:30:00Z",
  "data": {
    "validationId": "val_123",
    "workflowId": "wf_123",
    "jobId": "job_456",
    "anomaliesCountTotal": 15,
    "anomaliesChangeTotal": 10,
    "anomaliesByRule": [
      { "ruleName": "missing_values", "count": 8, "change": 5 }
    ],
    "previousJobId": "job_455",
    "workflowName": "Product Monitor",
    "createdAt": "2025-01-15T10:30:00Z"
  }
}