Skip to navigation

Job finished

POSTed to the job’s callback_url when it reaches succeeded, failed or canceled. Carries no document or results: fetch them with GET /v1/jobs/{id}/result. Verify the Formfill-Signature: t=<unix>,v1=<hex> header: HMAC-SHA256 of "<t>.<raw body>" with your organization’s signing secret; reject timestamps older than 5 minutes. Respond 2xx; otherwise delivery is retried with backoff for up to 12 hours.

Payload

The payload of this webhook request is an object.
event"job.finished"Required
idstringRequired
typeenumRequired
Allowed values:
statusenumRequired
Allowed values:
completed_atstring or nullRequired
expires_atstringRequired

Response

200
Successful Response