Webhooks

A new image was generated

Sent to targetUrl for each image generated from the subscribed template.

postWebhooknewImage

Payload

idstring required

The ID of the generated image.

templateIdstring

The ID of the template it was generated from.

templateNamestring

The name of that template.

imageUrlstring uri required

URL of the generated image, or of the PDF when the format is pdf.

thumbnailUrlstring uri

Thumbnail URL, fitting a 300x300px square.

retinaThumbnailUrlstring uri

Thumbnail URL for retina displays, fitting a 600x600px square.

metadatastring

The custom metadata sent with the request.

widthinteger

Image width in pixels.

heightinteger

Image height in pixels.

Any 2xx status acknowledges the notification.

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.