Webhooks

If webhooks are provided for a job with the Assess method, then POST requests with content-type “application/json” are made to the webhook URL on the relevant events in the render pipeline. The request bodies are objects with fields as described below for each webhook. To make use of this yourself you will need a server running which can accept requests of these json objects.

"on_success"

Field	Type	Description	Required?
job_id	string	Job UUID.	Yes
upload_url	string	URL of the successfully generated and uploaded animation result.	Yes
duration	float	Length of animation in seconds.	Yes

"on_fail"

Field	Type	Description	Required?
job_id	string	Job UUID.	Yes
error	object	Details of the error, if available. Same format as Error Response above.	No

"on_running"

Field	Type	Description	Required?
job_id	string	Job UUID.	Yes