Webhooks

Triggered after rendering completes successfully or with failure.

id

ID will be the same as in /renders/new response.

render_url

  • If status='ready' -- render_url contains url of the image. Url is temporary and should be used only to download image to your servers as soon as webhook received.
  • If status='failed' -- render_url will be null.
postWebhookrender.ready

Payload

avatar_idstring uuid required

ID of corresponding avatar

user_idstring nullable required

ID of user owning the corresponding avatar

event'render.ready'
idstring uuid required

Render ID. Matches the one form /renders/new response

status'ready' | 'failed' required
render_urlstring nullable required

Temporary URL to render if rendering was successful or null if not. Use it to download the file and store it on your servers

Response

Successful Response

unknown required

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.