Set up a webhook

To keep track of the status of your renders, there are two approaches. The first approach is retrieving the status through a HTTP GET request. But polling can lead to excessive API calls, so webhooks are the recommended approach for tracking multiple videos simultaneously without exceeding API limits.

A webhook gives you a immediatelly signal when a render succeeds or fails. It involves setting up a URL endpoint in your application, which Creatomate invokes with a HTTP POST request containing the status of the render. The data sent to your webhook follows the format outlined here. If you need to pass application-specific information to your webhook, you can use the metadata field when initiating a new render which will be included in the data passed to the webhook.

You can configure webhooks at the project level by setting a default webhook URL in your Project Settings. You can also specify a unique webhook for individual renders by specifying the webhook_url parameter when creating a new render.