Skip to main content

video-processing-success

Video processing has completed successfully for all resolutions selected, and you can now store the videoId for when you need to retrieve the urls to the video resolutions at runtime. If your video is a public video you can simply store the urls provided in the event data object as you will not need to retrieve a signed url at runtime.

Webhook payload​

NameTypeRequiredDescription
webhookNamestringYesThe name of the webhook
videoIdstringYesThe ID of the video
eventvideo-processing-successYesThe event that triggered the webhook
customMetadataJson | nullYesCustom metadata passed by the user to be associated with the create video api call. Always present, null when none was set
dataObjectYesThe response data from the video creation (see below)

Webhook data object​

NameTypeRequiredDescription
idstringYesThe ID of the video
isPublicbooleanYesWhether the video is public or not
resolutionsobjectYesThe video resolutions data, keyed by resolution (e.g. 720p). Contains only the resolutions that were requested

Webhook resolutions object​

NameTypeRequiredDescription
statusstringYesThe status of the video resolution. Possible values: pending_upload, processing, ready, fail. Always ready for this event
videoUrlstringNoThe URL of the video resolution. Omitted for private videos
thumbnailImageUrlsstring[]NoThe URLs of the video resolution thumbnails. Omitted for private videos