Moments & videos webhook

Overview

This documentation describes the structure and fields of the Video Webhook response object for moments and videos.

Response object structure

Core fields

Field	Type	Description
id	String	Unique identifier for the content (SHA-1 hash)
sdkId	String	SDK-specific identifier
contentType	String	Type of content ("Moment" or "Video")
title	String	Title of the content
description	String	Detailed description of the content
publishDate	ISO 8601 DateTime	Date and time when the content was/will be published
status	String	Current status of the content ("Draft" or "Active")
aspectRatio	String	Aspect ratio of the video ("16x9", "9x16", "1x1", "2x3")
duration	Integer	Duration in milliseconds
videoThumbnailUrls	Array	Array of thumbnail objects containing url and aspectRatio
Labels	Array	Array of label objects with Title, Identifier, and Schedule information

Geo-targeting

"geoTargeting": {
    "includedGeos": String[] | "excludedGeos": String[]  // Array of country codes
}

Competition details

Field	Type	Description
competitionId	Integer	Identifier for the associated competition

Thumbnail URL object

"videoThumbnailUrls": [
    {
        "url": String,          // URL to the thumbnail image
        "aspectRatio": String   // Aspect ratio of the thumbnail (e.g., "16x9", "9x16", "1x1", "2x3")
    }
]

Label object

"Labels": [
    {
        "Title": String,         // Display title of the label
        "Identifier": String,    // Unique identifier for the label
        "ScheduleStart": ISO 8601 DateTime,  // When the label becomes active
        "ScheduleEnd": ISO 8601 DateTime | null  // When the label expires (null for no expiration)
    }
]

Example response

{
  "id": "FD7E4E19090F87246336DC4AE6AB2B98F3BA944F",
  "sdkId": "6746637f3b275d19fc7324d7",
  "contentType": "Moment",
  "title": "Phoenix Suns vs. Los Angeles Lakers - Game Highlights",
  "description": "Watch the Game Highlights from Phoenix Suns vs. Los Angeles Lakers, 11/26/2024",
  "aspectRatio": "16x9",
  "geoTargeting": {
    "includedGeos": [
      "nl"
    ]
  },
  "competitionId": 2,
  "contentType": "VIDEO",
  "publishDate": "2024-11-27T05:37:27.998153Z",
  "publishMethod": "AUTOMATIC",
  "creationSettings": {
    "ruleId": "44ab443e-4a62-48a8-bf66-ab21f0410d12",
    "ruleName": "Every Game - Game Highlights",
    "creationTimePeriod": "POST-GAME",
    "videoType": "Highlight"
  },
  "duration": 298365,
  "videoThumbnailUrls": [
    {
      "url": "https://graphicsfeprodeus2.prod-cdn.clipro.tv/dynamicassets/c425c9d3-be1b-4885-90cd-2ec2147fddcd.jpg",
      "aspectRatio": "1x1"
    },
    {
      "url": "https://graphicsfeprodeus2.prod-cdn.clipro.tv/dynamicassets/e5ae2729-0f21-428b-a113-6d02c4feba23.jpg",
      "aspectRatio": "2x3"
    },
    {
      "url": "https://editorsprodeus2-feeds.prod-cdn.clipro.tv/thumbnails/25b62426-9725-459c-8873-94f4b879aad1_0.jpg",
      "aspectRatio": "16x9"
    }
  ],
  "Labels": [{
    "Title": "first-label",
    "Identifier": "first-label",
    "ScheduleStart": "2024-12-01T09:38:45.3697283",
    "ScheduleEnd": null
  }, {
    "Title": "sec-lab",
    "Identifier": "sec-lab",
    "ScheduleStart": "2024-12-01T09:38:45.3697283",
    "ScheduleEnd": null
  }],
  "status": "Draft"
}