Webhooks

Register an endpoint with POST /api/v1/webhooks. assets.dev signs every delivery: verify the X-Studio-Signature header as an HMAC-SHA256 over <timestamp>.<body>. Deliveries can repeat, so store event IDs and ignore duplicates.

Events

render.completed — Delivered when a queued render finishes and the file is available.
render.failed — Delivered when a render fails after queue acceptance and any automatic refund has been applied.

A failed render is refunded automatically; its render.failed payload carries refunded: true.

Payloads

Request Body

application/json

Render completed webhook

TypeScript Definitions

Use the request body type in TypeScript.

id*string

type*string

createdAt*string

Match

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

Formatdate-time

data*

Response Body

Example Requests

POST/render.completed

Request Body

application/json

Render failed webhook

TypeScript Definitions

Use the request body type in TypeScript.

id*string

type*string

createdAt*string

Match

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

Formatdate-time

data*

Response Body

Example Requests

POST/render.failed

Events

Payloads

Request Body

Response Body

200

Request Bodyapplication/json

Request Body

Response Body

200

Request Bodyapplication/json

On this page