Webhooks

Setting up webhooks

Setting up webhooks into your teams infrastructure allows Revelio to communicate when there are relevant changes to your data.

Video Webhook

The video webhook url is provided when encoding a video as the webhookURL param in the request body. Any changes to the video status will be sent to the provide url.

Expected Responses

Video successfully encoded
videoIDstring
The uuid of the encoded video.
statusstring
The encoding status of the video.
Options: "processing", "done", "failed"
encodedVideoLinkstring
A presigned link to the encoded video.
Response
{
"videoID": "04d42OL9FDmfj8YCM6t1",
"status": "done",
"encodedVideoLink": "https://revelio-content-creator-store.s3.amazonaws.com/foobar.mp4?AWSAccessKeyId=AKIA3XNVFHNKYTKK5Z4M&Signature=randomSignature&Expires=1728400309",
},
Video failed encoding
videoIDstring
The uuid of the encoded video.
statusstring
The encoding status of the video.
Options: "processing", "done", "failed"
Response
{
"videoID": "04d42OL9FDmfj8YCM6t1",
"status": "failed",
},

Scan Webhook

Scan successfully decoded
scanIDstring
The uuid of the scanned video.
videoIDstring
The uuid of the encoded video source that matches the decoded information.
creatorIDstring
The uuid of the creator of the video.
statusstring
The encoding status of the scan.
Options: "inProgress", "success", "failed"
watermarkobject
The watermarking data to be decoded from the scan, provided as an object of key/value pairs in which both the key and the value are strings.
Response
{
"scanID": "00LzfkMA0rPRvJ3eMCKt",
"videoID": "04d42OL9FDmfj8YCM6t1",
"creatorID": "DKFJld4IXahEKL0lJ8VMEjsg3rr1",
"status": "success",
"watermark": {
"author": "Revelio",
"foo": "bar",
},
},
Scan failed to decoded
scanIDstring
The uuid of the scanned video.
statusstring
The encoding status of the scan.
Options: "inProgress", "success", "failed"
Response
{
"scanID": "00LzfkMA0rPRvJ3eMCKt",
"status": "failed",
},