Skip to main content

Webhooks


VP Player offers webhooks for Videos, Players and Ad Schedules!

You can setup webhooks directly from VP Player client interface through Properties > Webhooks, or follow the steps on the api documentation Manage API > Webhooks.

In VP Player you can create webhooks in order to automate notifications in the form of HTTP POST requests and send to registered subscribers from VP Player to notify them of an event happening in a service. Webhook will be active if a user chooses to activate it. You can setup an endpoint that must be a secure URL in which we will send HTTP requests and specify what events you are listening to in webhook filters. A webhook will be disabled (inactive) if there are multiple event message delivery failures as described in section below or if a user chooses to manually deactivate it. To receive events, a webhook subscriber must add the desired events (filters). Once an event happens we will send to you a message. If an attempt to send a webhook message has already failed we will retry according to this schedule:

  • Immediately
  • 5 seconds
  • 5 minutes
  • 30 minutes
  • 2 hours
  • 5 hours
  • 10 hours
  • 10 hours (in addition to the previous)

If all attempts to a specific webhook endpoint fail for a period of 5 days, the webhook will be disabled automatically.

Video webhooks

Video webhooks include these events: video.created, video.updated, video.deleted, video.publish.status.changed, video.encode.submitted, video.encode.started, video.encode.errored, video.encode.completed, video.encode.quality.started, video.encode.quality.errored, video.encode.quality.completed

Live video webhooks

Live video webhooks include these events: live.video.created, live.video.updated, live.video.deleted, live.video.status.changed, live.video.started, live.video.stopped, live.channel.created, live.channel.updated, live.channel.deleted, live.channel.status.changed

Audio webhooks

Audio webhooks include these events: audio.created, audio.updated, audio.deleted, audio.publish.status.changed, audio.encode.started, audio.encode.errored, audio.encode.completed, audio.encode.quality.started, audio.encode.quality.errored, audio.encode.quality.completed

Player webhooks

Player webhooks include these events: player.created, player.updated, player.deleted, player.version.changed, audio.player.created, audio.player.updated, audio.player.deleted, audio.player.version.changed

AdSchedule webhooks

AdSchedule webhooks include these events: adschedule.created, adschedule.updated, adschedule.deleted