A webhook is a common way for developers to integrate real-time updates in their application by providing an endpoint which Livepeer Studio can send events to.
A webhook event refers to a specific event in Livepeer that prompts a webhook to be fired. Once an event takes place, the webhook activates, “pushing” relevant information or notifications to the application endpoint.
See Webhooks.fyi for a great explainer on what webhooks are, as well as best practices for integration.
Webhooks can be created in Studio under the Developer/Webhooks page:
Types of Events
|The parent stream object’s isActive value is marked as true and the .m3u8 HLS URL works|
|The parent stream object’s isActive value should be marked as false and the .m3u8 HLS URL no longer works|
|This fires when a recording is ready to be downloaded|
|This fires when recording has started on an active stream|
|This fires after a stream with recording on has concluded and is not yet ready to be downloaded. Typically it takes 5 minutes for recordings to be ready for download.|
|This fires when we’ve successfully connected to the multistream target|
|This fires when we’ve encountered an error either while attempting to connect to the third party streaming service or while broadcasting.|
|This fires when we are no longer sending video to the multistream target.|
|This fires when a On Demand asset is created.|
|This fires when a On Demand asset is updated. The asset payload will contain a playback URL when playback is available.|
|This fires when a On Demand asset is ready. Playback will be available with all transcoded renditions.|
|This fires when a On Demand asset fails during the upload or during processing.|
|This fires when a On Demand asset is deleted.|
|This fires when a task is spawned. (For example, an On Demand upload)|
|This fires when a task is updated.|
|This fires when a task completes its execution successfully.|
|This fires when a task has failed.|
|A specialized webhook for playback access control. Unlike other events, this is only used for assets and streams that reference its ID on their playback policy.|