Create Webhook

post

https://ws.api.video/webhooks

Webhooks can push notifications to your server, rather than polling api.video for changes. We currently offer four events:

video.encoding.quality.completed Occurs when a new video is uploaded into your account, it will be encoded into several different HLS and mp4 qualities. When each version is encoded, your webhook will get a notification. It will look like { "type": "video.encoding.quality.completed", "emittedAt": "2021-01-29T16:46:25.217+01:00", "videoId": "viXXXXXXXX", "encoding": "hls", "quality": "720p"} . This request says that the 720p HLS encoding was completed.
live-stream.broadcast.started When a live stream begins broadcasting, the broadcasting parameter changes from false to true, and this webhook fires.
live-stream.broadcast.ended This event fires when a live stream has finished broadcasting.
video.source.recorded This event occurs when a live stream is recorded and submitted for encoding.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

*Retry policy: Our webhook service makes 3 attempts with 3sec interval between each one.

Body Params

events

array of strings

required

A list of the webhooks that you are subscribing to. There are Currently four webhook options:

video.encoding.quality.completed Occurs when a new video is uploaded into your account, it will be encoded into several different HLS and mp4 qualities. When each version is encoded, your webhook will get a notification. It will look like { \"type\": \"video.encoding.quality.completed\", \"emittedAt\": \"2021-01-29T16:46:25.217+01:00\", \"videoId\": \"viXXXXXXXX\", \"encoding\": \"hls\", \"quality\": \"720p\"} . This request says that the 720p HLS encoding was completed.
live-stream.broadcast.started When a live stream begins broadcasting, the broadcasting parameter changes from false to true, and this webhook fires.
live-stream.broadcast.ended This event fires when a live stream has finished broadcasting.
video.source.recorded Occurs when a live stream is recorded and submitted for encoding.

events*

url

string

required

The the url to which HTTP notifications are sent. It could be any http or https URL.

Responses

Language

Credentials

Basic

base64

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Created