Webhooks

Create a new webhook

post/api/v1/webhooks

Request

  • Base URL: https://api.korala.ai
  • URL: https://api.korala.ai/api/v1/webhooks
  • Auth: one of:
    • API key in header X-API-Key
    • bearer (a scheme the document does not define)

Request body

urlstring required
eventsWebhookEventType[] required
descriptionstring
mode'live' | 'test'

Which traffic this endpoint receives: live or test documents, sessions and workflows. API credentials pin the mode. Existing subscriptions cannot change mode.

Example request

{
  "url": "https://example.com/webhooks",
  "events": [
    "document_signed",
    "document_completed"
  ],
  "description": "Notifications for signed documents"
}

Response

idstring required
urlstring required
eventsWebhookEventType[] required
mode'live' | 'test' required

Which traffic this endpoint receives: live or test documents, sessions and workflows. API credentials pin the mode. Existing subscriptions cannot change mode.

isActiveboolean required
descriptionstring
createdAtstring date-time required
updatedAtstring date-time required
secretstring required

Secret for HMAC signature verification (only shown once)

Changes

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