Skip to main content

Audio webhooks

audio.*​

audio.created​

  • Event for when a new audio is created.
  • Event payload:
    {
      "data": {
        "Id": "bxxxxxx",
        "Title": "audio_title_1.mp3"
      },
      "eventTime": "2023-10-19T08:09:18.5811464Z",
      "eventType": "audio.created"
    }

audio.updated​

  • Event for when an audio is updated.
  • Event payload:
    {
      "data": {
        "Author": "",
        "CanEmbed": true,
        "CustomParameters": [],
        "Description": "",
        "PublicId": "bxxxxxx",
        "Source": "",
        "Thumbnail": "",
        "Title": "audio title"
      },
      "eventTime": "2023-10-19T08:53:07.5106592Z",
      "eventType": "audio.updated"
    }

audio.deleted​

  • Event for when an audio is deleted.
  • Event payload:
    {
      "data": {
        "Ids": [
          "bxxxxxx"
        ]
      },
      "eventTime": "2023-10-19T09:01:55.7151862Z",
      "eventType": "audio.deleted"
    }

audio.publish.status.changed​

  • Event for when an audio’s publish status changes.
  • Status changes that can be sent are:
    • Processing
    • Ready
    • Failed
    • ReEncoding
  • Event payload:
    {
      "data": {
        "Id": "bxxxxxx",
        "PublishStatusId": 2,
        "PublishStatusName": "Ready"
      },
      "eventTime": "2023-10-19T11:44:38.3438936Z",
      "eventType": "audio.publish.status.changed"
    }

audio.encode.started​

  • Event for when an audio starts encoding.
  • Event payload:
    {
      "data": {
        "AudioBitrate": 0,
        "AudioId": "bxxxxx",
        "AudioSampleRate": 0,
        "Bitrate": 0,
        "Duration": 0,
        "Height": 0,
        "MediaId": "bxxxxx",
        "MediaType": "Audio",
        "StatusDescription": "Processing",
        "StreamUrl": "https://cdn.vpplayer.tech/axxxxx/audio-xxxxx/bxxxxx/hls/master_file.m3u8",
        "Width": 0
      },
      "eventTime": "2023-10-24T14:42:04.8841212Z",
      "eventType": "audio.encode.started"
    }

audio.encode.errored​

  • Event for when an audio encoding failed due to errors.
  • Event payload:
    {
      "data": {
          "AudioBitrate": 0,
        "AudioId": "bxxxxx",
        "AudioSampleRate": 0,
        "Bitrate": 0,
        "Height": 0,
        "MediaId": "bxxxxx",
        "MediaType": "Audio",
        "Width": 0
      },
      "eventTime": "2023-10-19T11:04:32.7747559Z",
      "eventType": "audio.encode.errored"
    }

audio.encode.completed​

  • Event for when an audio encoding has finished.
  • Event payload:
    {
      "data": {
        "AudioBitrate": 0,
        "AudioSampleRate": 0,
        "Bitrate": 0,
        "Duration": 392.65,
        "Height": 0,
        "StatusDescription": "Complete",
        "StreamUrl": "https://cdn.vpplayer.tech/axxxxx/audio-encode/bxxxxx/hls/master_file.m3u8",
        "Width": 0
      },
      "eventTime": "2023-10-19T11:04:32.7808665Z",
      "eventType": "audio.encode.completed"
    }

audio.encode.quality.started​

  • Event for when an audio’s quality encoding has started.
  • Event payload:
    {
      "data": {
        "AudioBitrate": 0,
        "AudioId": "bxxxxx",
        "AudioSampleRate": 0,
        "Bitrate": 0,
        "Duration": 348.081633,
        "Height": 0,
        "MediaId": "bxxxxx",
        "Progress": 0,
        "QualityType": "128kbps",
        "Size": 0,
        "StatusDescription": "Processing",
        "StreamUrl": "https://cdn.vpplayer.tech/axxxxxx/audio-encode/bxxxxx/flac",
        "Width": 0
      },
      "eventTime": "2023-10-24T14:42:17.8537069Z",
      "eventType": "audio.encode.quality.started"
    }

audio.encode.quality.errored​

  • Event for when an audio’s quality encoding has failed due to errors.
  • Event payload:
    {
      "data": {
        "AudioBitrate": 0,
        "AudioId": "bxxxxx",
        "AudioSampleRate": 0,
        "Bitrate": 0,
        "Duration": 348.081633,
        "Height": 0,
        "MediaId": "bxxxxx",
        "Progress": 0,
        "QualityType": "128kbps",
        "Size": 0,
        "StatusDescription": "Error",
        "StreamUrl": "https://cdn.vpplayer.tech/axxxxxx/audio-encode/bxxxxx/flac",
        "Width": 0
      },
      "eventTime": "2023-10-24T14:42:17.8537069Z",
      "eventType": "audio.encode.quality.started"
    }

audio.encode.quality.completed​

  • Event for when an audio’s quality encoding has finished.
  • Event payload:
    {
      "data": {
        "AudioBitrate": 0,
        "AudioId": "bxxxxxx",
        "AudioSampleRate": 0,
        "Bitrate": 0,
        "Duration": 516.519184,
        "Height": 0,
        "MediaId": "bxxxxxx",
        "MediaType": "Audio",
        "Progress": 100,
        "QualityType": "320kbps",
        "Size": 8380612,
        "StatusDescription": "Complete",
        "StreamUrl": "https://cdn.vpplayer.tech/axxxxxx/audio-encode/bxxxxxx/hls/320kbps/audio/index.m3u8",
        "Width": 0
      },
      "eventTime": "2023-10-19T08:10:08.6869569Z",
      "eventType": "audio.encode.quality.completed"
    }