Receiving Videos

When you create a dynamic video using our API, the video rendering process is asynchronous. This means that you'll need to set up a webhook to receive the video once it's ready. Here's how the process works:

You create a video using the Create a Video endpoint.
You receive an immediate response with a renderId and status: "pending".
Once the video is ready, we'll send a POST request to your webhook URL with the video details.

Webhook Payload

When the video is ready, you'll receive a POST request to your webhook URL with the following payload:

{
    "status": "success",
    "videoUrl": "https://assets.krumzi.com/videos/1234567890.mp4",
    "renderId": "render_12345abcde",
    "templateId": "template_12345abcde"
}

Field	Type	Description
status	string	The status of the video render. Will be "success" for completed videos.
videoUrl	string	The URL where you can download the completed video.
renderId	string	The unique identifier for this render job.
templateId	string	The ID of the template used to create this video.

Setting Up Webhooks

To receive video completion notifications, you need to subscribe to webhooks for specific templates. See the following pages for details:

Create a Video Adding a Webhook