GuidesAPI ReferenceRelease Notes
HomeLog InHome
Guides

These webhooks fire when Videos are created, updated, or deleted. The Videos content type follows the same structure as Moments, and is used for longer-form video content.

Webhook structure

Example

{
    "Action": "Update",
    "ActionTime": "2025-01-20T13:43:00.828Z",
    "ContentId": "678e516ed0015dfac1abbb1d",
    "ContentType": "Video",
    "Content": {
        "Type": "Video",
        "Id": "678e516ed0015dfac1abbb1d",
        "Title": "Full Game Highlights",
        "Description": "",
        "Subtitle": "",
        "Version": 0,
        "AspectRatios": ["Horizontal", "Vertical"],
        "Status": "Active",
        "Duration": 180.5,
        "CreateTime": "2025-01-20T13:36:46.504Z",
        "UpdateTime": "2025-01-20T13:36:46.504Z",
        "Thumbnails": [
            {
                "Url": "https://example.com/thumbnail.jpg",
                "AspectRatio": "TwoToThree"
            }
        ],
        "GeoTargeting": {
            "IncludedGeos": null,
            "ExcludedGeos": null
        },
        "Metadata": {
            "Competition": {
                "Provider": null,
                "ProviderId": null,
                "WscId": 2
            },
            "Game": {
                "Provider": null,
                "ProviderId": "0022400345",
                "WscId": 103225680
            },
            "Team": {
                "Provider": null,
                "ProviderId": "1610612763",
                "WscId": 1015
            },
            "Player": {
                "Provider": null,
                "ProviderId": "1629630",
                "WscId": 774871
            }
        },
        "ExecutionTimeType": "None",
        "Labels": [
            {
                "Title": "Game Highlights",
                "Identifier": "game-highlights"
            }
        ]
    }
}

Content fields

FieldTypeDescription
TypestringAlways "Video" for video content
IdstringUnique identifier for the video
TitlestringTitle of the video
DescriptionstringOptional description text
SubtitlestringOptional subtitle text
VersionnumberContent version number
AspectRatiosstring[]Available aspect ratios for this content
StatusstringCurrent status (e.g., "Active", "Draft")
DurationnumberDuration in seconds
CreateTimestringISO 8601 timestamp of creation
UpdateTimestringISO 8601 timestamp of last update

Thumbnails

Each thumbnail object contains:

  • Url: Direct URL to the thumbnail image
  • AspectRatio: Aspect ratio of the thumbnail

Metadata

Content metadata includes:

  • Competition: Competition information
  • Game: Game-specific identifiers
  • Team: Team information
  • Player: Player information

Each metadata object contains:

  • Provider: External provider identifier
  • ProviderId: ID from the provider's system
  • WscId: Internal WSC identifier

Labels

Labels are used for content categorization and contain:

  • Title: Display name of the label
  • Identifier: Unique identifier for the label

Key differences from Moments

While Videos share the same structure as Moments, they are typically used for:

  • Longer-form content
  • Full game highlights
  • Feature content
  • Documentary-style content

The main technical difference is the ContentType and Content.Type values, which are set to "Video" instead of "Moment".


Did this page help you?