Skip to main content

Video webhooks

video.*​

video.created​

  • Event for when a new VOD video is created.
  • Event payload:
    {
      "data": {
        "Id": "vxxxxxx"
      },
      "eventTime": "2023-10-19T08:08:32.1637433Z",
      "eventType": "video.created"
    }

video.updated​

  • Event for when a video is updated.
  • Event payload
    {
      "data": {
        "Author": "",
        "CanEmbed": true,
        "CanPreview": true,
        "CustomParameters": [],
        "Description": "",
        "Duration": 393,
        "FilmstripUrl": "https://cdn.vpplayer.tech/axxxxx/encode/vxxxxxx/thumbnails/filmstrip0.jpg",
        "FilmstripVttUrl": "https://cdn.vpplayer.tech/axxxxxx/encode/vxxxxxx/thumbnails/filmstrip.vtt",
        "InsertDate": "2023-10-19T08:08:32.0409595",
        "IsLive": "False",
        "Name": "Kid Francescoli - _Moon_ (Official Video).mp4",
        "PublicId": "vjsnnvbo",
        "PublishStatusId": 2,
        "PublishStatusName": "Ready",
        "SkipIntroState": false,
        "Source": "",
        "TagNames": [],
        "ThumbnailUrl": "https://cdn.vpplayer.tech/axxxxxx/encode/vxxxxxx/thumbnails/retina.jpg",
        "Title": "Kid Francescoli - _Moon_ (Official Video) Update",
        "VideoPagePermalink": "",
        "VisibilityOption": "Public",
        "VisibilityOptionId": 1
      },
      "eventTime": "2023-10-19T08:14:09.9662921Z",
      "eventType": "video.updated"
    }

video.deleted​

  • Event for when a video is deleted.
  • Event payload
    {
      "data": {
        "Id": "vxxxxxx",
        "Title": "Kid Francescoli - _Moon_ (Official Video) Update"
      },
      "eventTime": "2023-10-19T08:16:20.1390571Z",
      "eventType": "video.deleted"
    }

video.publish.status.changed​

  • Event for when a video’s publish status changes.
  • Publish statuses that can be sent are:
    • Processing - 1
    • Ready - 2
    • Failed - 4
    • ReEncoding -8
  • Event payload
    {
      "data": {
        "Id": "vxxxxxx",
        "PublishStatusId": 2,
        "PublishStatusName": "Ready"
      },
      "eventTime": "2023-10-19T08:09:54.1548922Z",
      "eventType": "video.publish.status.changed"
    }

video.encode.submitted​

  • Event for when a video is submitted for encoding.
  • Event payload
  • StreamUrl will be provided only for videos that support OnTheFlyPackager.
    {
      "data": {
        "Id": "vxxxxxx",
        "StreamUrl": "https://cdn.vpplayer.tech/axxxxxx/fly/uploads/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/file/master.m3u8"
      },
      "eventTime": "2023-10-19T08:08:38.8347687Z",
      "eventType": "video.encode.submitted"
    }

video.encode.started​

  • Event for when a video starts encoding.
  • Event payload:
    {
      "data": {
        "AudioBitrate": 0,
        "AudioSampleRate": 0,
        "Bitrate": 0,
        "Duration": 0,
        "Height": 0,
        "StatusDescription": "Processing",
        "StreamUrl": "https://cdn.vpplayer.tech/axxxxx/encode/vxxxx/hls/master_file.m3u8",
        "Width": 0
      },
      "eventTime": "2023-10-19T09:32:00.4583949Z",
      "eventType": "video.encode.started"
    }

video.encode.errored​

  • Event for when a video encoding fails as a result of an error.
  • Event payload:
    {
      "data":  {
        "AudioBitrate": 2276,
        "AudioCodec": "aac",
        "AudioSampleRate": 48000,
        "Bitrate": 5528049,
        "Duration": 323,
        "Height": 1080,
        "MediaId": "vxxxxxx",
        "Progress": 100,
        "QualityType": "1080p",
        "Size": 223567643,
        "StatusDescription": "Error",
        "StreamUrl": "",
        "VideoId": "vxxxxxx",
        "Width": 1920
      },
      "eventTime": "2023-10-19T09:32:00.4585451Z",
      "eventType": "video.encode.errored"
    }

video.encode.completed​

  • Event for when a video encoding has completed
  • Event payload:
    {
      "data": {
        "AudioBitrate": 0,
        "AudioSampleRate": 0,
        "Bitrate": 0,
        "Duration": 392.649375,
        "Height": 0,
        "StatusDescription": "Complete",
        "StreamUrl": "https://cdn.vpplayer.tech/axxxxxx/encode/vxxxxxx/hls/master_file.m3u8",
        "Width": 0
      },
      "eventTime": "2023-10-19T08:10:29.1468861Z",
      "eventType": "video.encode.completed"
    }

video.encode.quality.started​

  • Event for when a video’s quality encoding has started.
  • Event payload:
    {
      "data": {
        "AudioBitrate": 0,
        "AudioSampleRate": 0,
        "Bitrate": 0,
        "Duration": 392.65,
        "Height": 0,
        "MediaId": "vxxxxxx",
        "Progress": 0,
        "QualityType": "480p",
        "Size": 0,
        "StatusDescription": "Processing",
        "StreamUrl": "https://cdn.vpplayer.tech/axxxxxxx/encode/vxxxx/hls/460p/index.m3u8",
        "VideoId": "vxxxx",
        "Width": 0
      },
      "eventTime": "2023-10-19T09:32:00.460609Z",
      "eventType": "video.encode.quality.started"
    }

video.encode.quality.errored​

  • Event for when a video’s quality encoding has failed as a result of an error.
  • Event payload:
    {
      "data": {
        "AudioBitrate": 2276,
        "AudioCodec": "aac",
        "AudioSampleRate": 48000,
        "Bitrate": 5528049,
        "Duration": 323,
        "Height": 1080,
        "MediaId": "vxxxxxx",
        "Progress": 100,
        "QualityType": "1080p",
        "Size": 223567643,
        "StatusDescription": "Error",
        "StreamUrl": "",
        "VideoId": "vxxxxxx",
        "Width": 1920
      },
      "eventTime": "2023-10-19T09:32:00.4603771Z",
      "eventType": "video.encode.quality.errored"
    }

video.encode.quality.completed​

  • Event for when a video’s quality has finished encoding.
  • Event payload:
    {
      "data": {
        "AudioBitrate": 40191,
        "AudioCodec": "aac",
        "AudioSampleRate": 44100,
        "Bitrate": 211081,
        "Duration": 392.649375,
        "Height": 240,
        "MediaId": "vxxxxxx",
        "Progress": 100,
        "QualityType": "240p",
        "Size": 12666907,
        "StatusDescription": "Complete",
        "StreamUrl": "https://cdn.vpplayer.tech/axxxxxx/encode/vxxxxxx/hls/240p/index.m3u8",
        "VideoId": "vxxxxxx",
        "Width": 426
      },
      "eventTime": "2023-10-19T08:09:48.1787669Z",
      "eventType": "video.encode.quality.completed"
    }

video.thumbnail.changed​

  • Event for when a video's thumbnail change
  • Event payload:
{

  "data": {
    "Path": "https://cdn.vpplayer.tech/axxxxxx/images/vxxxxxx/thumbnail.webp?time=398",
     "Id": "vxxxxxx"
  },
  "eventTime": "2024-03-28T14:36:42.6962472Z",
  "eventType": "video.thumbnail.changed",
  "projectId": "axxxxxx"

}