Webhook

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/api-video/json-schema/api-video-webhook-schema.json",
  "title": "Webhook",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/api-video-webhooks-api-openapi.yml#/components/schemas/webhook",
  "type": "object",
  "properties": {
    "webhookId": {
      "type": "string",
      "description": "A unique identifier of the webhook you subscribed to."
    },
    "createdAt": {
      "type": "string",
      "description": "The time and date when you created this webhook subscription, in ATOM UTC format.",
      "format": "date-time"
    },
    "events": {
      "type": "array",
      "description": "A list of events that you subscribed to. When these events occur, the API triggers a webhook call to the URL you provided.",
      "items": {
        "type": "string",
        "enum": [
          "live-stream.broadcast.started",
          "live-stream.broadcast.ended",
          "video.source.recorded",
          "video.encoding.quality.completed",
          "video.caption.generated",
          "video.summary.generated"
        ]
      }
    },
    "url": {
      "type": "string",
      "description": "The URL where the API sends the webhook."
    },
    "signatureSecret": {
      "type": "string",
      "description": "A secret key for the webhook you subscribed to. You can use it to verify the origin of the webhook call that you receive."
    }
  }
}