Webhook events

All webhook events will follow the same pattern - at the top level, there will be two keys, one that describes the event that occurred and the other the event-specific payload.

Event Object Keys	Description
type string	The event type, currently `video.completed` only.
data	The event payload.

The video.completed event is sent when a video finishes processing and is as follows. Note that we do not send it when a template preview completes.

"video.completed" Object Keys	Description
id string	Unique identifier for the video.
title string	Title of the video (used on the video's share page).
description string	Description of the video (used on the video's share page).
visibility string	Describes the private settings of the video. - If `public`, the video's share page is active. - If `private`, the video's share page is not active; visitors will receive a 404 Not Found response.
status string	Describes the processing status of the video. - `in_progress`: the video is being processed. - `complete`: the video was processed successfully. - `error`: an error occurred during processing. - `rejected`: the video was rejected during moderation due to inappropriate content.
download string	A time-limited URL which may be used to download the video. This field is only available if the video status is `complete`.
duration string	Duration of the video. This field is only available if the video status is `complete`.
callbackId string	Arbitrary metadata set for the video when creating the video.
createdAt integer	UNIX timestamp representing the time video was created.
lastUpdatedAt integer	UNIX timestamp representing the time video was last updated.

{
  "type": "video.completed",
  "data": {
    ...
  }
}

{
  "type": "video.completed",
  "data": {
    "id": "1234-...",
    "title": "Hello, World!",
    "description": "This is my first synthetic video, made with the Synthesia API!",
    "visibility": "private",
    "status": "complete",
    "download": "https://...",
    "duration": "0:00:59.000000",
    "callbackId": "[email protected]",
    "createdAt": 1602512112,
    "lastUpdatedAt": 1602512112
  }
}