Webhooks

Triggered when export completes successfully or with failure.

export_url

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

Payload

avatar_idstring uuid required

ID of corresponding avatar

user_idstring nullable required

ID of user owning the corresponding avatar

event'export.ready'
status'ready' | 'failed' required
export_urlstring nullable required

Temporary URL to export result or null if export failed

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.