Skip to main content

Webhooks

Your application can use webhooks to get notifications from Editframe about events related to your Editframe application and videos

Update your Editframe application's webhook URL in the dashboard

Events

Editframe sends a request to your webhook for the following events, indicated by the event property in the webhook body:

Video events

Video created

This event is fired when video encoding completes

Body properties

PropertyValue
download_urlVideo download url
event'video.created'
idVideo id
metadataVideo metadata
stream_urlVideo stream url
thumbnail_urlVideo thumbnail url
timestampUnix timestamp of the time the video was transcoded

Example body

{
"download_url": "https://api.editframe.com/v2/videos/kdZ2mNbxJg/download?client_id=GbjsM0enkgOOyKOqd7QnJZ",
"event": "video.created",
"id": "kdZ2mNbxJg",
"metadata": {},
"stream_url": "https://api.editframe.test/v2/videos/kdZ2mNbxJg/stream?client_id=GbjsM0enkgOOyKOqd7QnJZ",
"thumbnail_url": "https://api.editframe.test/v2/videos/kdZ2mNbxJg/thumbnail?client_id=GbjsM0enkgOOyKOqd7QnJZ",
"timestamp": 1651784008
}

Video failed

This event is fired when video encoding fails

Body properties

PropertyValue
event'video.failed'
idVideo ID
metadataVideo metadata
timestampUnix timestamp of the time the webhook request was made

Example body

{
"event": "video.failed",
"id": "yKOqd7QnJZ",
"metadata": {},
"timestamp": 1651781472
}

Test event

This event is fired when you update your webhook to ensure it works

Example

{
"event": "webhook.test",
"timestamp": 1651780129
}