Skip to main content

Audio Player Webhooks

audio.player.created​

  • Event for when an audio player is created.
  • Event payload: 
    {
  "eventTime": "2024-07-18T07:49:23.6349181Z",
  "eventType": "audio.player.created",
  "data": {
    "PublicId": "{PublicId}",
    "Name": "{Name}",
    "LoopContent": false,
    "FloatOnScroll": false,
    "EnablePlayBackRateControls": true,
    "Sharing": false,
    "Casting": false,
    "ShowContentTitle": true,
    "ShowContentDescription": true,
    "ShowControls": false,
    "ShowPodcastTitle": false,
    "Recommendation": false,
    "PodcastId": 0,
    "Advertising": false,
    "ChromeCastButton": true,
    "ShareButton": false,
    "AirplayButton": true,
    "AutoPlay": true,
    "FloatDismissible": false,
    "LogoOn": true,
    "FocusOnAutoStart": false,
    "FloatOnMobile": false,
    "FloatRequiresInteraction": false,
    "ShowPlaylist": false,
    "FloatWidth": 340,
    "LogoUrl": "",
    "LogoOnClickUrl": "",
    "CloudHostedPlayerLibrary": "{CloudHostedPlayerLibrary}",
    "ResponsiveSize": 100,
    "FloatPositionOptionId": 1,
    "PlayerTypeId": 1,
    "ReleaseChannelId": 1,
    "GradientDirectionOptionId": 1,
    "Volume": 0.5,
    "SkipAmount": 1,
    "HighligshtCurrentAudio": false,
    "BackgroundUseThumbnail": false,
    "BackgroundBlur": false,
    "BackgroundGradient": false,
    "BackgroundBorderWidth": 0,
    "ElementsVolumeButtonOn": true,
    "ElementsSkipButtonOn": true,
    "ElementsSettingsButtonOn": true,
    "ElementsNextPrevButtonOn": true,
    "ElementsListButtonOn": true,
    "ShowHelperButton": false,
    "ShowAutoPlay": false,
    "ShowQualities": false,
    "Play": "Play",
    "Pause": "Pause",
    "Next": "Next",
    "Replay": "Replay",
    "VolumeText": "Volume",
    "Mute": "Mute",
    "UnMute": "Unmute",
    "Settings": "Settings",
    "ChromeCast": "ChromeCast",
    "Airplay": "Airplay",
    "Playlist": "Related",
    "Quality": "Quality",
    "Autoplay": "Autoplay",
    "PlaybackSpeed": "Speed",
    "Auto": "Auto",
    "Off": "Off",
    "Normal": "Normal",
    "Share": "Share Audio",
    "PauseOtherAudios": true,
    "AutoStartOnViewableOn": false,
    "AutoStartOnViewableMobile": false,
    "AutoStartOnViewableOnData": false,
    "AutoStartOnViewablePercentage": 0.5,
    "AutoPauseOnViewableOn": false,
    "AutoPauseOnViewablePercentage": 0.5,
    "AutoPauseOnCuePointOn": false,
    "AutoPauseOnCuePointTimeToPause": 0,
    "AutoPauseOnCuePointContinueUnMuted": false,
    "AutoPauseOnCuePointOnDesktop": false,
    "AutoPauseOnCuePointOnMobile": false,
    "JumpBackAfterMidrollOn": false,
    "JumpBackAfterMidrollTime": 3,
    "ReadQualities": false,
    "AudioSocialNetworkIds": [],
    "BackgroundPrimaryColor": "011030",
    "BackgroundSecondaryColor": "EA622B",
    "BackgroundBorderColor": "FFFFFF",
    "ElementsPrimaryColor": "FFFFFF",
    "ElementsSecondaryColor": "FFFFFF",
    "ElementsPlaylistColor": "011030",
    "ElementsItemsProgressColor": "FFFFFF",
    "ElementsPlaybackButtonColor": "FFFFFF",
    "ElementsVolumeButtonColor": "FFFFFF",
    "ElementsSkipButtonColor": "FFFFFF",
    "ElementsSettingsButtonColor": "FFFFFF",
    "ElementsNextPrevButtonColor": "FFFFFF",
    "ElementsListButtonColor": "FFFFFF",
    "ElementsTimeInfoColor": "FFFFFF",
    "ElementsTitleColor": "FFFFFF",
    "ElementsAuthorColor": "FFFFFF",
    "ElementsDescriptionColor": "FFFFFF",
    "ElementsDefaultColor": "FFFFFF",
    "ElementsLogoColor": "",
    "ElementsDividersColor": "FFFFFF",
    "ElementsSliderRailColor": "FFFFFF",
    "ElementsSliderProgressBarColor": "EA622B",
    "ElementsDraggerColor": "FFFFFF",
    "ElementsItemColor": "FFFFFF",
    "MenuBackgroundDefaultColor": "011030",
    "MenuTextDefaultColor": "FFFFFF",
    "MenuToggleDefaultColor": "FFFFFF",
    "MenuToggleOnColor": "206ED5",
    "MenuToggleOffColor": "CACACA"
  },
  "projectId": "{projectId}"
  }

audio.player.updated​

  • Event for when an audio player was updated.
  • Event payload: 
    {
  "eventTime": "2024-07-18T07:51:02.7961019Z",
  "eventType": "audio.player.updated",
  "data": {
    "PublicId": "{PublicId}",
    "Name": "{Name}",
    "LoopContent": false,
    "FloatOnScroll": false,
    "EnablePlayBackRateControls": true,
    "Sharing": false,
    "Casting": false,
    "ShowContentTitle": true,
    "ShowContentDescription": true,
    "ShowControls": false,
    "ShowPodcastTitle": false,
    "Recommendation": false,
    "PodcastId": 0,
    "Advertising": false,
    "ChromeCastButton": true,
    "ShareButton": false,
    "AirplayButton": true,
    "AutoPlay": true,
    "FloatDismissible": false,
    "LogoOn": true,
    "FocusOnAutoStart": false,
    "FloatOnMobile": false,
    "FloatRequiresInteraction": false,
    "ShowPlaylist": false,
    "FloatWidth": 340,
    "LogoUrl": "",
    "LogoOnClickUrl": "",
    "CloudHostedPlayerLibrary": "{CloudHostedPlayerLibrary}",
    "ResponsiveSize": 100,
    "FloatPositionOptionId": 1,
    "PlayerTypeId": 1,
    "ReleaseChannelId": 1,
    "GradientDirectionOptionId": 1,
    "Volume": 0.5,
    "SkipAmount": 1,
    "HighligshtCurrentAudio": false,
    "BackgroundUseThumbnail": false,
    "BackgroundBlur": false,
    "BackgroundGradient": false,
    "BackgroundBorderWidth": 0,
    "ElementsVolumeButtonOn": true,
    "ElementsSkipButtonOn": true,
    "ElementsSettingsButtonOn": true,
    "ElementsNextPrevButtonOn": true,
    "ElementsListButtonOn": true,
    "ShowHelperButton": false,
    "ShowAutoPlay": false,
    "ShowQualities": false,
    "Play": "Play",
    "Pause": "Pause",
    "Next": "Next",
    "Replay": "Replay",
    "VolumeText": "Volume",
    "Mute": "Mute",
    "UnMute": "Unmute",
    "Settings": "Settings",
    "ChromeCast": "Chromecast",
    "Airplay": "Airplay",
    "Playlist": "Related",
    "Quality": "Quality",
    "Autoplay": "Autoplay",
    "PlaybackSpeed": "Speed",
    "Auto": "Auto",
    "Off": "Off",
    "Normal": "Normal",
    "Share": "Share Audio",
    "PauseOtherAudios": true,
    "AutoStartOnViewableOn": false,
    "AutoStartOnViewableMobile": false,
    "AutoStartOnViewableOnData": false,
    "AutoStartOnViewablePercentage": 0.5,
    "AutoPauseOnViewableOn": false,
    "AutoPauseOnViewablePercentage": 0.5,
    "AutoPauseOnCuePointOn": false,
    "AutoPauseOnCuePointTimeToPause": 0,
    "AutoPauseOnCuePointContinueUnMuted": false,
    "AutoPauseOnCuePointOnDesktop": false,
    "AutoPauseOnCuePointOnMobile": false,
    "JumpBackAfterMidrollOn": false,
    "JumpBackAfterMidrollTime": 3,
    "ReadQualities": false,
    "ReleaseChannel": {
      "Id": 1,
      "Name": "v1.0",
      "OriginalPath": "{OriginalPath}",
      "TemplateOriginalPath": "{TemplateOriginalPath}"
    },
    "PlayerType": {
      "Id": 1,
      "Name": "Mini Thumbnail Player",
      "Value": "MINI_THUMBNAIL_PLAYER"
    },
    "FloatPositionOption": {
      "Id": 1,
      "Name": "Top Right",
      "Value": "TOP_RIGHT"
    },
    "AudioSocialNetworkIds": [],
    "BackgroundPrimaryColor": "011030",
    "BackgroundSecondaryColor": "EA622B",
    "BackgroundBorderColor": "FFFFFF",
    "ElementsPrimaryColor": "FFFFFF",
    "ElementsSecondaryColor": "FFFFFF",
    "ElementsPlaylistColor": "011030",
    "ElementsItemsProgressColor": "FFFFFF",
    "ElementsPlaybackButtonColor": "FFFFFF",
    "ElementsVolumeButtonColor": "FFFFFF",
    "ElementsSkipButtonColor": "FFFFFF",
    "ElementsSettingsButtonColor": "FFFFFF",
    "ElementsNextPrevButtonColor": "FFFFFF",
    "ElementsListButtonColor": "FFFFFF",
    "ElementsTimeInfoColor": "FFFFFF",
    "ElementsTitleColor": "FFFFFF",
    "ElementsAuthorColor": "FFFFFF",
    "ElementsDescriptionColor": "FFFFFF",
    "ElementsDefaultColor": "FFFFFF",
    "ElementsLogoColor": "",
    "ElementsDividersColor": "FFFFFF",
    "ElementsSliderRailColor": "FFFFFF",
    "ElementsSliderProgressBarColor": "EA622B",
    "ElementsDraggerColor": "FFFFFF",
    "ElementsItemColor": "FFFFFF",
    "MenuBackgroundDefaultColor": "011030",
    "MenuTextDefaultColor": "FFFFFF",
    "MenuToggleDefaultColor": "FFFFFF",
    "MenuToggleOnColor": "206ED5",
    "MenuToggleOffColor": "CACACA"
  },
  "projectId": "{projectId}"
  }

audio.player.deleted​

  • Event for when an audio player has been deleted.
  • Event payload: 
  {
  "eventTime": "2024-07-18T07:52:35.0199373Z",
  "eventType": "audio.player.deleted",
  "data": {
    "Id": "{Id}",
    "Name": "{Name}"
  },
  "projectId": "{projectId}"
   }

audio.player.version.changed​

  • Event for when an audio player’s version has changed.
  • Event payload: 

    {
      "eventTime": "2023-10-19T11:22:49.2490786Z",
      "eventType": "audio.player.version.changed",
      "data": {
        "Id": "{Id}",
        "ReleaseChannelId": 201,
        "ReleaseChannelName": "v2.0"
      },
      
    }