WebhooksCreationPayload

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/api-video/json-schema/api-video-webhooks-creation-payload-schema.json",
  "title": "WebhooksCreationPayload",
  "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/webhooks-creation-payload",
  "required": [
    "events",
    "url"
  ],
  "type": "object",
  "properties": {
    "events": {
      "type": "array",
      "description": "An array of webhook events that you want to subscribe to.",
      "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 the url to which HTTP notifications are sent. It could be any http or https URL."
    }
  }
}