Skip to main content

Live webhooks

live.video.*

live.video.created

  • Event for when a livestreaming video is created.
  • Event payload:
    {
    "data": {
    "Author": "John Smith",
    "CanCutAndPublish": true,
    "CanStopAndCut": true,
    "ChannelName": "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "ChannelPublicId": "cxxxxxx",
    "ChannelTitle": "channel title 1",
    "CountdownEnabled": false,
    "CountdownSeconds": 0,
    "Description": "",
    "HasCustomDate": false,
    "PlaybackUrl": "https://cdn.vpplayer.tech/axxxxxx/livestream/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/master_file.m3u8",
    "PublicId": "vxxxxxx",
    "Thumbnail": "https://cdn.vpplayer.tech/axxxxxx/livestream/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/thumbnail.jpg",
    "Title": "live video test"
    },
    "eventTime": "2023-10-19T08:38:02.8236169Z",
    "eventType": "live.video.created"
    }

live.video.updated

  • Event for when a livestreaming video is updated.
  • Event payload:
    {
    "data": {
    "Author": "John Smith",
    "CanCutAndPublish": false,
    "CanStopAndCut": false,
    "ChannelPublicId": "vxxxxxx",
    "CountdownEnabled": false,
    "CountdownSeconds": 0,
    "HasCustomDate": false,
    "PlaybackUrl": "",
    "PublicId": "vxxxxxx",
    "Thumbnail": "",
    "Title": "Live Video Update"
    },
    "eventTime": "2023-10-19T08:40:34.8356926Z",
    "eventType": "live.video.updated"
    }

live.video.deleted

  • Event for when a livestreaming video is deleted.
  • Event payload:
    {
    "data": {
    "Id": "vxxxxxx",
    "Title": "Video Title"
    },
    "eventTime": "2023-10-19T08:48:40.5377727Z",
    "eventType": "live.video.deleted"
    }

live.video.status.changed

  • Event for when a livestreaming video’s status changes.
  • Live video’s statuses that can be sent are:
    • Live
    • Offline
    • Processing
    • Interrupted
  • Event payload:
    {
    "data": {
    "ActiveChannelId": "cxxxxxx",
    "HealthStatus": "Healthy",
    "HealthStatusId": 1,
    "Id": "vxxxxxx",
    "PlaybackUrl": "https://cdn.vpplayer.tech/axxxxxx/livestream/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/master_file.m3u8",
    "Status": "Processing",
    "StatusId": 3
    },
    "eventTime": "2023-10-19T08:41:46.8021483Z",
    "eventType": "live.video.status.changed"
    }

live.video.started

  • Event for when a livestreaming video starts streaming.
  • Event payload
    {
    "data": {
    "Id": "vxxxxxx",
    "LiveStartDateUTC": "2023-10-19T08:41:48.1059974Z"
    },
    "eventTime": "2023-10-19T08:41:48.1386249Z",
    "eventType": "live.video.started"
    }

live.video.stopped

  • Event for when a livestreaming video stops streaming.
  • Event payload:
    {
    "data": {
    "Id": "vxxxxxx"
    },
    "eventTime": "2023-10-19T08:47:24.9456174Z",
    "eventType": "live.video.stopped"
    }

live.channel.*

live.channel.created

  • Event for when a livestreaming channel is created.
  • Event payload:
    {
    "data": {
    "HealthStatus": "Unknown",
    "LiveStatus": "Offline",
    "LivestreamProvider": "Captain",
    "LivestreamProviderId": 0,
    "Name": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx",
    "PlaybackUrl": "",
    "PublicId": "cxxxxxx",
    "StreamId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
    "StreamKey": "xxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
    "StreamServer": "rtmp://alpha.ingest.gjirafa.tech/live/",
    "Title": "Live Channel Test"
    },
    "eventTime": "2023-10-19T08:09:45.7788317Z",
    "eventType": "live.channel.created"
    }

live.channel.updated

  • Event for when a livestreaming channel is updated.
  • Event payload:
    {
    "data": {
    "HealthStatus": "Unknown",
    "LiveStatus": "Offline",
    "LivestreamProvider": "Captain",
    "LivestreamProviderId": 0,
    "Name": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx",
    "PlaybackUrl": "",
    "PublicId": "cxxxxxxx",
    "StreamId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "StreamKey": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "StreamServer": "rtmp://alpha.ingest.gjirafa.tech/live/",
    "Title": "Live Channel Test Update"
    },
    "eventTime": "2023-10-19T08:09:56.9704243Z",
    "eventType": "live.channel.updated"
    }

live.channel.deleted

  • Even for when a livestreaming channel is deleted
  • Event payload:
    {
    "data": {
    "Id": "cxxxxxxxx",
    "Name": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    },
    "eventTime": "2023-10-19T08:33:46.8325386Z",
    "eventType": "live.channel.deleted"
    }

live.channel.status.changed

  • Event for when a livestreaming channel status changes.
  • Live channel’s statuses that can be sent are:
    • Offline
    • Processing
    • Live
    • Interrupted
  • Event payload:
    {
    "data": {
    "HealthStatus": "Healthy",
    "HealthStatusId": 1,
    "Id": "vxxxxxx",
    "LiveStatus": "Processing",
    "LiveStatusId": 3,
    "Name": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "Title": "captain live channel test"
    },
    "eventTime": "2023-10-19T08:35:20.1056912Z",
    "eventType": "live.channel.status.changed"
    }