Skip to main content

Audio Webhooks

audio.created​

  • Event for when a new audio is created.
  • Event payload: 
{
  "eventTime": "2024-07-17T12:03:06.5009843Z",
  "eventType": "audio.created",
  "data": {
    "Id": "{Id}",
    "Title": "{Title}",
    "Author": "{Author}"
  },
  "projectId": "{projectId}"
}

audio.updated​

  • Event for when an audio is updated.
  • Event payload: 
{
  "eventTime": "2024-07-17T12:19:23.6341154Z",
  "eventType": "audio.updated",
  "data": {
    "PublicId": "{PublicId}",
    "Title": "{Title}",
    "Description": "",
    "Source": "",
    "Author": "",
    "Thumbnail": "",
    "CanEmbed": true,
    "Link": "",
    "ChapterState": false,
    "InsertDate": "2024-07-17T12:06:22.5136993",
    "CustomParameters": [],
    "Chapters": []
  },
  "projectId": "{projectId}"
}

audio.deleted​

  • Event for when multiple audios are deleted
  • Event payload: 
{
  "eventTime": "2024-07-17T12:18:56.3035905Z",
  "eventType": "audio.deleted",
  "data": {
    "Ids": [
      "{Ids}"
    ]
  },
  "projectId": "{projectId}"
}

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: 
{
  "eventTime": "2024-07-17T12:15:00.7526373Z",
  "eventType": "audio.publish.status.changed",
  "data": {
    "Id": "{Id}",
    "PublishStatusId": 2,
    "PublishStatusName": "Ready"
  },
  "projectId": "{projectId}"
}

audio.encode.started​

  • Event for when an audio starts encoding.
  • Event payload: 
{
  "eventTime": "2024-07-17T12:03:09.6753021Z",
  "eventType": "audio.encode.started",
  "data": {
    "Id": "{Id}",
    "AudioId": "{AudioId}",
    "MediaId": "{MediaId}",
    "MediaType": "Audio",
    "StreamUrl": "{StreamUrl}",
    "StatusDescription": "Processing",
    "Status": "Processing",
    "Duration": 0,
    "Width": 0,
    "Height": 0,
    "Bitrate": 0,
    "AudioBitrate": 0,
    "AudioSampleRate": 0,
    "StartDateTime": "2025-02-14T13:08:28.129Z",
    "EndDateTime": "2025-02-14T13:08:28.129Z"
  },
  "projectId": "{projectId}"
}

audio.encode.completed​

  • Event for when an audio encoding has finished.
  • Event payload: 
{
  "eventTime": "2024-07-17T12:15:00.7838567Z",
  "eventType": "audio.encode.completed",
  "data": {
    "Id": "{Id}",
    "AudioId": "{AudioId}",
    "MediaId": "{MediaId}",
    "MediaType": "Audio",
    "StreamUrl": "{StreamUrl}",
    "StatusDescription": "Complete",
    "Status": "Complete",
    "Duration": 224.664,
    "Width": 0,
    "Height": 0,
    "Bitrate": 0,
    "AudioBitrate": 0,
    "AudioSampleRate": 0,
    "StartDateTime": "2025-02-14T13:08:28.129Z",
    "EndDateTime": "2025-02-14T13:08:28.129Z"
  },
  "projectId": "{projectId}"
}

audio.encode.errored​

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

audio.encode.quality.started​

  • Event for when an audio’s quality encoding has started.
  • Event payload: 
{
  "eventTime": "2024-07-17T12:03:17.6551788Z",
  "eventType": "audio.encode.quality.started",
  "data": {
    "Id": "{Id}",
    "AudioId": "AudioId",
    "MediaId": "{MediaId}",
    "MediaType": "Audio",
    "QualityType": "192kbps",
    "StreamUrl": "{StreamUrl}",
    "StatusDescription": "Processing",
    "Status": "Processing",
    "Duration": 19.722449,
    "Size": 0,
    "Width": 0,
    "Height": 0,
    "Bitrate": 0,
    "AudioBitrate": 0,
    "AudioSampleRate": 0,
    "Progress": 0,
    "StartDateTime": "2025-02-14T13:08:28.129Z",
    "EndDateTime": "2025-02-14T13:08:28.129Z"
  },
  "projectId": "{projectId}"
}

audio.encode.quality.completed​

  • Event for when an audio’s quality encoding has finished.
  • Event payload: 
{
  "eventTime": "2024-07-17T12:14:37.0761644Z",
  "eventType": "audio.encode.quality.completed",
  "data": {
    "Id": "{Id}",
    "AudioId": "{AudioId}",
    "MediaId": "{MediaIdvvv}",
    "MediaType": "Audio",
    "QualityType": "128kbps",
    "StreamUrl": "{StreamUrl}",
    "StatusDescription": "Complete",
    "Status": "Complete",
    "Duration": 224.664,
    "Size": 3595053,
    "Width": 0,
    "Height": 0,
    "Bitrate": 0,
    "AudioBitrate": 0,
    "AudioSampleRate": 0,
    "Progress": 100,
    "StartDateTime": "2025-02-14T13:08:28.129Z",
    "EndDateTime": "2025-02-14T13:08:28.129Z"
  },
  "projectId": "{projectId}"
}

audio.encode.quality.errored​

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

audio.item.deleted​

  • Event for when an audio is deleted.
  • Event payload: 
{
  "eventTime": "2024-07-17T12:18:56.3035905Z",
  "eventType": "audio.item.deleted",
  "data": {
       "Id": "{Id}"
  },
  "projectId": "{projectId}"
}