Skip to main content

Video Player Webhooks

player.created​

  • Event for when a video player is created.
  • Event payload: 
    {
  "eventTime": "2024-07-17T11:11:22.7956276Z",
  "eventType": "player.created",
  "data": {
    "PublicId": "{PublicId}",
    "Name": "{Name}",
    "LoopContent": false,
    "MuteOnStart": true,
    "FloatOnScroll": false,
    "AutoPauseWhenNotViewable": false,
    "EnablePlayBackRateControls": true,
    "Sharing": false,
    "Casting": false,
    "GoogleAnalytics": false,
    "IncludeCompatibilityScript": false,
    "ShowContentTitle": true,
    "ShowContentDescription": true,
    "ShowControls": true,
    "Recommendation": false,
    "Advertising": false,
    "ShowControlsOnVPAID": false,
    "OutstreamPlayer": false,
    "DispAdverisementAbove": false,
    "AutoCollapseAfterAds": false,
    "PreloadAds": false,
    "CompanionAds": false,
    "PlayAdsMuted": true,
    "AllowSeekOnLive": false,
    "SeekLiveAfterPause": false,
    "KeepVisibleWhenControlsHidden": false,
    "Debug": false,
    "TheaterButton": true,
    "ChromeCastButton": true,
    "NextButton": true,
    "FullScreenButton": true,
    "PictureInPictureButton": false,
    "VolumeButton": true,
    "ShareButton": false,
    "AirplayButton": true,
    "SettingsButton": true,
    "BigPlayButton": true,
    "AudioOnlyButton": false,
    "AutoPlay": true,
    "FloatDismissible": false,
    "LogoOn": false,
    "AdsRequireInteraction": false,
    "FocusOnAutoStart": false,
    "FloatOnMobile": false,
    "FloatRequiresInteraction": false,
    "FloatWidth": "340",
    "LogoUrl": "",
    "LogoOnClickUrl": "",
    "LogoDefaultOpacity": 1,
    "LogoInactiveOpacity": 0.5,
    "MidrollSentenceAlignment": false,
    "ChannelUrl": "",
    "CloudHostedPlayerLibrary": "{CloudHostedPlayerLibrary}",
    "Width": 640,
    "Height": 360,
    "PlayerSizeTypeId": 1,
    "PreloadOptionId": 2,
    "DefaultBandwidthEstimateOptionId": 1,
    "LogoPositionOptionId": 1,
    "FloatPositionOptionId": 1,
    "ResponsiveSizeOptionId": 1,
    "ReleaseChannelId": 210,
    "CountDownMessage": "string",
    "CueText": "string",
    "SkipCountDown": "string",
    "CompanionAdsDivID": "string",
    "CompanionAdsWidth": 0,
    "CompanionAdsHeight": 0,
    "Volume": 0.5,
    "SkipAmount": 1,
    "HighlightCurrentVideo": false,
    "OnHoverPlay": false,
    "ControlBarGradientMidpoint": 50,
    "ControlBarSpreadOptionId": 1,
    "ShowHelperButton": false,
    "HelperButtonImageUrl": "",
    "ShowLiveIcon": false,
    "DelayLiveVideosTime": 0,
    "DelayLiveVideos": false,
    "ShowAutoPlay": false,
    "ShowQualities": false,
    "ShowSubtitles": false,
    "Play": "Play",
    "Pause": "Pause",
    "Next": "Next",
    "UpNext": "Up Next",
    "Replay": "Replay",
    "VolumeText": "Volume",
    "Mute": "Mute",
    "UnMute": "Unmute",
    "Settings": "Settings",
    "FullScreen": "FullScreen",
    "Chromecast": "Chromecast",
    "Airplay": "Airplay",
    "PictureInPicture": "Picture In Picture",
    "SkipIntro": "Skip Intro",
    "ContinueWatching": "Continue Watching",
    "Quality": "Quality",
    "Subtitles": "Subtitles",
    "Autoplay": "Autoplay",
    "PlaybackRate": "Playback Rate",
    "Auto": "Auto",
    "Off": "Off",
    "Normal": "Normal",
    "Share": "Share",
    "Theater": "Theater",
    "Skip": "Skip",
    "SkipIn": "SkipIn",
    "Visit": "Visit",
    "Info": "Info",
    "SimultaneousAds": "Simultaneous Ads",
    "AutoplayOff": "Autoplay off",
    "AutoplayOn": "Autoplay on",
    "ZoomIn": "Zoom in",
    "ZoomOut": "Zoom out",
    "OriginalZoom": "Original Zoom",
    "ContinueAfterPause": "Continue playing",
    "CaptionsOff": "Captions off",
    "Live": "Live",
    "ChromeCastPlayingOn": "Chromecast playing",
    "Dismiss": "Dismiss",
    "PlayNow": "Play Now",
    "NextVideoCancel": "Cancel",
    "AdAnnouncement": "Ad will start in",
    "PlaybackErrorTitle": "There was a problem playing this video.",
    "PlaybackErrorDescription": "Unfortunately, this video could not be played at this moment. Please try refreshing your browser.",
    "GeoBlockedTitle": "Video not available in your country.",
    "GeoBlockedDescription": "Unfortunately, the publisher has not made this video available in your country.",
    "StreamInterruptedTitle": "Livestream is interrupted",
    "StreamInterruptedDescription": "Something went wrong. Try refreshing the page.",
    "StreamStartingTitle": "Livestream is starting soon",
    "StreamStartingDescription": "Please wait, livestream is about to start soon",
    "UnpublishedTitle": "Embedding is disabled",
    "UnpublishedDescription": "Adjust privacy settings or wait for the specified publish date to arrive.",
    "Playlist": "Related",
    "PrivateTitle": "",
    "PrivateDescription": "This video cannot be played because it is set as private.",
    "PauseOtherVideos": true,
    "AutoStartOnLoad": true,
    "AutoStartOnLoadMobile": false,
    "AutoStartOnLoadOnData": false,
    "AutoStartOnViewableOn": false,
    "AutoStartOnViewableMobile": false,
    "AutoStartOnViewableOnData": false,
    "AutoStartOnViewablePercentage": 0.5,
    "AutoPauseOnViewableOn": false,
    "AutoPauseOnViewablePercentage": 0.5,
    "AutoPauseOnCuePointState": false,
    "AutoPauseOnCuePointTimeToPause": 0,
    "AutoPauseOnCuePointContinueUnMuted": false,
    "AutoPauseOnCuePointOnDesktop": false,
    "AutoPauseOnCuePointOnMobile": false,
    "AutoPauseOnCuePointPlayButtonUrl": "",
    "AutoPauseOnCuePointPlayButtonPath": "",
    "PauseWhenRelatedIsShown": false,
    "ReadQualities": false,
    "EnableGravityChange": false,
    "ForceSound": false,
    "ShowPlayerControlsDuringVideoAdvertisement": false,
    "EnableHapticFeedbackOnButtonClick": false,
    "EnableHapticFeedbackOnPinchToZoom": false,
    "AdAnnouncementState": false,
    "AdAnnouncementTimeBeforeAd": 5,
    "AfterMidrollBacktrackState": false,
    "AfterMidrollBacktrackTime": 3,
    "ReleaseChannel": {
      "Id": 210,
      "Name": "v2.0.9",
      "OriginalPath": "{OriginalPath}",
      "TemplateOriginalPath": "{TemplateOriginalPath}"
    },
    "PlayerSizeType": {
      "Id": 1,
      "Name": "Responsive"
    },
    "PreloadOption": {
      "Id": 2,
      "Name": "Quick Start (default)",
      "Value": "metadata",
      "TooltipText": "For the fastest startup time. When the player becomes viewable or if it's the only player on the embedded page, the player will load the media's metadata and up to one segment."
    },
    "DefaultBandwidthEstimateOption": {
      "Id": 1,
      "Name": "None",
      "Value": "0"
    },
    "ResponsiveSizeOption": {
      "Id": 1,
      "Name": "16:9",
      "Width": 16,
      "Height": 9
    },
    "LogoPositionOption": {
      "Id": 1,
      "Name": "Top right (default)",
      "Value": "TOP_RIGHT"
    },
    "FloatPositionOption": {
      "Id": 1,
      "Name": "Top right (default)",
      "Value": "TOP_RIGHT"
    },
    "SocialNetworkIds": [],
    "ControlBarTextColor": "ffffff",
    "ControlBarIconsDefaultColor": "ffffff",
    "ControlBarIconsHoverColor": "ffffff",
    "ControlBarTimesliderProgressColor": "F26822",
    "ControlBarTimesliderRailColor": "FFFFFF80",
    "ControlBarTimesliderDraggerColor": "F26822",
    "ControlBarBackgroundColor": "FFFFFF00",
    "ControlBarTimesliderBufferColor": "e2e2e2",
    "ControlBarVolumeDraggerColor": "ffffff",
    "ControlBarVolumeProgressColor": "ffffff",
    "ControlBarVolumeRailColor": "9f9f9f",
    "ControlBarVolumeNotifierColor": "0000004d",
    "ControlBarTimeSliderOnAdDraggerColor": "ffffff",
    "ControlBarTimeSliderOnAdProgressColor": "f5c338",
    "ControlBarTimeSliderOnAdRailColor": "808080",
    "ControlBarLoaderColor": "808080",
    "MenuLinksDefaultColor": "ffffff",
    "MenuLinksHoverColor": "F26822",
    "MenuBackroundDefaultColor": "1c1c1cb3",
    "MenuBackroundHoverColor": "00000080",
    "MenuAutoplayOnColor": "cc0000",
    "MenuAutoplayOffColor": "a7a7a7",
    "NextVideoBackgroundColor": "2e2e2e",
    "NextVideoTextColor": "FFFFFF",
    "NextVideoTsRailColor": "000000",
    "NextVideoTsProgressColor": "FFFFFF",
    "NextVideoTsIconsCloseColor": "FFFFFF",
    "NextVideoIconsPlayDefaultColor": "FFFFFF",
    "NextVideoIconsPlayHoverColor": "FFFFFF",
    "NextVideoCancelTextColor": "000000",
    "NextVideoCancelBackgroundColor": "FFFFFF",
    "NextVideoPlayNowTextColor": "000000",
    "NextVideoPlayNowBackgroundColor": "FFFFFF",
    "PlaylistBackgroundColor": "1c1c1cb3",
    "PlaylistTextColor": "FFFFFF",
    "PlaylistCardBackgroundColor": "1c1c1cb3",
    "PlaylistCardTitleColor": "FFFFFF",
    "PlaylistCardDurationTextColor": "FFFFFF",
    "PlaylistCardDurationBackgroundColor": "1a1a1a80",
    "PlaylistCardIconPlayDefaulColor": "FFFFFF",
    "PlaylistCardIconPlayHoverColor": "FFFFFF",
    "PlaylistIconsArrActiveColor": "FFFFFF",
    "PlaylistIconsArrInactiveColor": "666666",
    "PlaylistIconsCloseColor": "FFFFFF",
    "TooltipsTextColor": "ffffff00",
    "TooltipsBackroundColor": "ffffff00"
  },
  "projectId": "{projectId}"
  }

player.updated​

  • Event for when a video player is updated.
  • Event payload: 
   {
  "eventTime": "2024-07-17T11:13:15.0437808Z",
  "eventType": "player.updated",
  "data": {
    "PublicId": "{PublicId}",
    "Name": "{Name}",
    "LoopContent": false,
    "MuteOnStart": true,
    "FloatOnScroll": false,
    "AutoPauseWhenNotViewable": false,
    "EnablePlayBackRateControls": true,
    "Sharing": false,
    "Casting": false,
    "GoogleAnalytics": false,
    "IncludeCompatibilityScript": false,
    "ShowContentTitle": true,
    "ShowContentDescription": true,
    "ShowControls": true,
    "Recommendation": false,
    "Advertising": false,
    "ShowControlsOnVPAID": false,
    "OutstreamPlayer": false,
    "DispAdverisementAbove": false,
    "AutoCollapseAfterAds": false,
    "PreloadAds": false,
    "CompanionAds": false,
    "PlayAdsMuted": true,
    "AllowSeekOnLive": false,
    "SeekLiveAfterPause": false,
    "KeepVisibleWhenControlsHidden": false,
    "Debug": false,
    "TheaterButton": true,
    "ChromeCastButton": true,
    "NextButton": true,
    "FullScreenButton": true,
    "PictureInPictureButton": false,
    "VolumeButton": true,
    "ShareButton": false,
    "AirplayButton": true,
    "SettingsButton": true,
    "BigPlayButton": true,
    "AudioOnlyButton": false,
    "AutoPlay": true,
    "FloatDismissible": false,
    "LogoOn": false,
    "AdsRequireInteraction": false,
    "FocusOnAutoStart": true,
    "FloatOnMobile": false,
    "FloatRequiresInteraction": false,
    "FloatWidth": "340",
    "LogoUrl": "",
    "LogoOnClickUrl": "",
    "LogoDefaultOpacity": 1,
    "LogoInactiveOpacity": 0.5,
    "MidrollSentenceAlignment": false,
    "ChannelUrl": "",
    "CloudHostedPlayerLibrary": "{CloudHostedPlayerLibrary}",
    "Width": 640,
    "Height": 360,
    "PlayerSizeTypeId": 1,
    "PreloadOptionId": 2,
    "DefaultBandwidthEstimateOptionId": 1,
    "LogoPositionOptionId": 1,
    "FloatPositionOptionId": 1,
    "ResponsiveSizeOptionId": 1,
    "ReleaseChannelId": 210,
    "CountDownMessage": "string",
    "CueText": "string",
    "SkipCountDown": "string",
    "CompanionAdsDivID": "string",
    "CompanionAdsWidth": 0,
    "CompanionAdsHeight": 0,
    "Volume": 0.5,
    "SkipAmount": 1,
    "HighlightCurrentVideo": false,
    "OnHoverPlay": true,
    "ControlBarGradientMidpoint": 50,
    "ControlBarSpreadOptionId": 1,
    "ShowHelperButton": false,
    "HelperButtonImageUrl": "",
    "ShowLiveIcon": false,
    "DelayLiveVideosTime": 0,
    "DelayLiveVideos": false,
    "ShowAutoPlay": false,
    "ShowQualities": false,
    "ShowSubtitles": false,
    "Play": "Play",
    "Pause": "Pause",
    "Next": "Next",
    "UpNext": "Up Next",
    "Replay": "Replay",
    "VolumeText": "Volume",
    "Mute": "Mute",
    "UnMute": "Unmute",
    "Settings": "Settings",
    "FullScreen": "FullScreen",
    "Chromecast": "Chromecast",
    "Airplay": "Airplay",
    "PictureInPicture": "Picture In Picture",
    "SkipIntro": "Skip Intro",
    "ContinueWatching": "Continue Watching",
    "Quality": "Quality",
    "Subtitles": "Subtitles",
    "Autoplay": "Autoplay",
    "PlaybackRate": "Playback Rate",
    "Auto": "Auto",
    "Off": "Off",
    "Normal": "Normal",
    "Share": "Share",
    "Theater": "Theater",
    "Skip": "Skip",
    "SkipIn": "SkipIn",
    "Visit": "Visit",
    "Info": "Info",
    "SimultaneousAds": "Simultaneous Ads",
    "AutoplayOff": "Autoplay off",
    "AutoplayOn": "Autoplay on",
    "ZoomIn": "Zoom in",
    "ZoomOut": "Zoom out",
    "OriginalZoom": "Original Zoom",
    "ContinueAfterPause": "Continue playing",
    "CaptionsOff": "Captions off",
    "Live": "Live",
    "ChromeCastPlayingOn": "Chromecast playing",
    "Dismiss": "Dismiss",
    "PlayNow": "Play Now",
    "NextVideoCancel": "Cancel",
    "AdAnnouncement": "Ad will start in",
    "PlaybackErrorTitle": "There was a problem playing this video.",
    "PlaybackErrorDescription": "Unfortunately, this video could not be played at this moment. Please try refreshing your browser.",
    "GeoBlockedTitle": "Video not available in your country.",
    "GeoBlockedDescription": "Unfortunately, the publisher has not made this video available in your country.",
    "StreamInterruptedTitle": "Livestream is interrupted",
    "StreamInterruptedDescription": "Something went wrong. Try refreshing the page.",
    "StreamStartingTitle": "Livestream is starting soon",
    "StreamStartingDescription": "Please wait, livestream is about to start soon",
    "UnpublishedTitle": "Embedding is disabled",
    "UnpublishedDescription": "Adjust privacy settings or wait for the specified publish date to arrive.",
    "Playlist": "Related",
    "PrivateTitle": "",
    "PrivateDescription": "This video cannot be played because it is set as private.",
    "PauseOtherVideos": true,
    "AutoStartOnLoad": true,
    "AutoStartOnLoadMobile": false,
    "AutoStartOnLoadOnData": false,
    "AutoStartOnViewableOn": false,
    "AutoStartOnViewableMobile": false,
    "AutoStartOnViewableOnData": false,
    "AutoStartOnViewablePercentage": 0.5,
    "AutoPauseOnViewableOn": false,
    "AutoPauseOnViewablePercentage": 0.5,
    "AutoPauseOnCuePointState": false,
    "AutoPauseOnCuePointTimeToPause": 0,
    "AutoPauseOnCuePointContinueUnMuted": false,
    "AutoPauseOnCuePointOnDesktop": false,
    "AutoPauseOnCuePointOnMobile": false,
    "AutoPauseOnCuePointPlayButtonUrl": "",
    "AutoPauseOnCuePointPlayButtonPath": "",
    "PauseWhenRelatedIsShown": false,
    "ReadQualities": false,
    "EnableGravityChange": false,
    "ForceSound": false,
    "ShowPlayerControlsDuringVideoAdvertisement": false,
    "EnableHapticFeedbackOnButtonClick": false,
    "EnableHapticFeedbackOnPinchToZoom": false,
    "AdAnnouncementState": false,
    "AdAnnouncementTimeBeforeAd": 5,
    "AfterMidrollBacktrackState": false,
    "AfterMidrollBacktrackTime": 3,
    "ReleaseChannel": {
      "Id": 210,
      "Name": "v2.0.9",
      "OriginalPath": "{OriginalPath}",
      "TemplateOriginalPath": "{TemplateOriginalPath}"
    },
    "PlayerSizeType": {
      "Id": 1,
      "Name": "Responsive"
    },
    "PreloadOption": {
      "Id": 2,
      "Name": "Quick Start (default)",
      "Value": "metadata",
      "TooltipText": "For the fastest startup time. When the player becomes viewable or if it's the only player on the embedded page, the player will load the media's metadata and up to one segment."
    },
    "DefaultBandwidthEstimateOption": {
      "Id": 1,
      "Name": "None",
      "Value": "0"
    },
    "ResponsiveSizeOption": {
      "Id": 1,
      "Name": "16:9",
      "Width": 16,
      "Height": 9
    },
    "LogoPositionOption": {
      "Id": 1,
      "Name": "Top right (default)",
      "Value": "TOP_RIGHT"
    },
    "FloatPositionOption": {
      "Id": 1,
      "Name": "Top right (default)",
      "Value": "TOP_RIGHT"
    },
    "SocialNetworkIds": [],
    "ControlBarTextColor": "ffffff",
    "ControlBarIconsDefaultColor": "ffffff",
    "ControlBarIconsHoverColor": "ffffff",
    "ControlBarTimesliderProgressColor": "F26822",
    "ControlBarTimesliderRailColor": "FFFFFF80",
    "ControlBarTimesliderDraggerColor": "F26822",
    "ControlBarBackgroundColor": "FFFFFF00",
    "ControlBarTimesliderBufferColor": "e2e2e2",
    "ControlBarVolumeDraggerColor": "ffffff",
    "ControlBarVolumeProgressColor": "ffffff",
    "ControlBarVolumeRailColor": "9f9f9f",
    "ControlBarVolumeNotifierColor": "0000004d",
    "ControlBarTimeSliderOnAdDraggerColor": "ffffff",
    "ControlBarTimeSliderOnAdProgressColor": "f5c338",
    "ControlBarTimeSliderOnAdRailColor": "808080",
    "ControlBarLoaderColor": "808080",
    "MenuLinksDefaultColor": "ffffff",
    "MenuLinksHoverColor": "F26822",
    "MenuBackroundDefaultColor": "1c1c1cb3",
    "MenuBackroundHoverColor": "00000080",
    "MenuAutoplayOnColor": "cc0000",
    "MenuAutoplayOffColor": "a7a7a7",
    "NextVideoBackgroundColor": "2e2e2e",
    "NextVideoTextColor": "FFFFFF",
    "NextVideoTsRailColor": "000000",
    "NextVideoTsProgressColor": "FFFFFF",
    "NextVideoTsIconsCloseColor": "FFFFFF",
    "NextVideoIconsPlayDefaultColor": "FFFFFF",
    "NextVideoIconsPlayHoverColor": "FFFFFF",
    "NextVideoCancelTextColor": "000000",
    "NextVideoCancelBackgroundColor": "FFFFFF",
    "NextVideoPlayNowTextColor": "000000",
    "NextVideoPlayNowBackgroundColor": "FFFFFF",
    "PlaylistBackgroundColor": "1c1c1cb3",
    "PlaylistTextColor": "FFFFFF",
    "PlaylistCardBackgroundColor": "1c1c1cb3",
    "PlaylistCardTitleColor": "FFFFFF",
    "PlaylistCardDurationTextColor": "FFFFFF",
    "PlaylistCardDurationBackgroundColor": "1a1a1a80",
    "PlaylistCardIconPlayDefaulColor": "FFFFFF",
    "PlaylistCardIconPlayHoverColor": "FFFFFF",
    "PlaylistIconsArrActiveColor": "FFFFFF",
    "PlaylistIconsArrInactiveColor": "666666",
    "PlaylistIconsCloseColor": "FFFFFF",
    "TooltipsTextColor": "ffffff00",
    "TooltipsBackroundColor": "ffffff00"
  },
  "projectId": "{projectId}"
  }

player.deleted​

  • Event for when a video player has been deleted.
  • Event payload: 
   {
  "eventTime": "2024-07-17T11:14:44.5188168Z",
  "eventType": "player.deleted",
  "data": {
    "Id": "{Id}",
    "Name": "{Name}"
  },
  "projectId": "{projectId}"
  }

player.version.changed​

  • Event for when a video player’s version has changed.
  • Event payload: 
   {
  "eventTime": "2024-07-17T11:15:20.2559074Z",
  "eventType": "player.version.changed",
  "data": {
    "Id": "{Id}",
    "ReleaseChannelId": 209,
    "ReleaseChannelName": "v2.0.8"
  },
  "projectId": "{projectId}"
  }