Webhooks

Payload schema

Two fields. All clip data is inside payload, and nonce is the input your decryption routine needs to read it.

Request body

json

{
  "nonce":   "3n8Qw1ZpLcVtRxYs",
  "payload": "yTf9kQ2p…base64…Xr7Lm4=="
}

Field	Type	Description
`nonce`	string, base64	A 12-byte initialization vector, unique to this delivery. Not secret, and safe to log.
`payload`	string, base64	The encrypted clip data, being ciphertext followed by a 16-byte authentication tag.

Decrypted payload

Decrypting payload yields UTF-8 JSON.

json

{
  "deliveryId":     "8f14e45f-ea6a-4c1b-9d3a-2b7c1f0e5a88",
  "timestamp":      "2026-08-21T14:32:07Z",
  "name":           "Penalty save 68'",
  "streamName":     "Manchester City vs Arsenal",
  "tournamentName": "Premier League 2026/27",
  "s3url":          "https://media.spectatr.ai/clips/…?X-Amz-Expires=604800&X-Amz-Signature=…",
  "aspectRatio":    "16:9",
  "language":       "en"
}

Field	Type	Presence	Description
`deliveryId`	uuid	ALWAYS	Identifies this delivery, and stays the same across retries. Record it, and skip any delivery already processed.
`timestamp`	ISO 8601	ALWAYS	The UTC time the clip became available. Describes the clip, so it does not advance on a retry.
`name`	string	ALWAYS	The clip title, as entered by an operator. Neither unique nor permanent, because operators rename clips, so it is not a key. `Penalty save 68'`
`streamName`	string	ALWAYS	The event the clip came from, a fixture for sports, or the stream's own title for anything else. This one field covers both. `Manchester City vs Arsenal`, `Opening Ceremony, Main Stage`
`tournamentName`	string	OPTIONAL	The competition the event belongs to. Empty or absent for non-sports streams and for fixtures outside a competition, so do not require it. `Premier League 2026/27`
`s3url`	url	ALWAYS	A time-limited download link for the MP4, valid 7 days from `timestamp`. Fetch it with a plain GET; no authentication headers are needed.
`aspectRatio`	string	ALWAYS	The frame shape of this rendition. All clips are delivered in HD. `16:9`, `9:16`, `4:5`, `1:1`
`language`	ISO 639-1	ALWAYS	The audio language of this rendition. `en`, `ar`, `hi`