Webhooks

Create webhook

post/webhooks

Request

  • Base URL: https://klaaro.ai/api/v1
  • URL: https://klaaro.ai/api/v1/webhooks
  • Auth: HTTP bearer

Request body

datasetIdstring uuid required

Dataset UUID (from GET /datasets).

urlstring uri required
eventsWebhookEvent[] required
descriptionstring

Response

Created — signingSecret shown once

idstring uuid required
urlstring uri required
eventsWebhookEvent[] required
descriptionstring nullable
secretLast4string nullable
lastDeliveryAtstring date-time nullable
lastStatusstring nullable
createdAtstring date-time required
updatedAtstring date-time required
signingSecretstring

HMAC signing secret — shown once on creation. Store securely; cannot be retrieved again.

Example response

{
  "id": "c0a8012d-3d0f-4c5f-8d5a-8e9dfb4a9b52",
  "url": "https://example.com/klaaro/webhook",
  "events": [
    "document.uploaded",
    "document.extraction_completed"
  ],
  "description": "Production webhook endpoint",
  "secretLast4": "a1b2",
  "lastDeliveryAt": "2026-05-22T13:00:00Z",
  "lastStatus": "delivered",
  "createdAt": "2026-05-01T10:12:00Z",
  "updatedAt": "2026-05-22T13:00:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.