Webhooks
Receive pipeline events over HTTPS — signed deliveries, retries and auto-disable.
5 min read
Webhooks push pipeline events to your own HTTP endpoints: a page finished OCR, a translation completed or failed, a render is ready. Instead of polling status, your backend reacts as the pipeline progresses.
Register an endpoint
- 1Open Settings → API → Webhooks
- 2Add your HTTPS URL and pick the events to receive
- 3Save — Jokai signs every delivery so you can verify it came from us
- 4Use the test button to fire a sample event at your endpoint
Verifying signatures
Every delivery carries an X-Jokai-Signature header, Stripe-style: t=<timestamp>,v1=<hmac>. The HMAC-SHA256 covers “<timestamp>.<raw-body>” with your endpoint’s signing secret. Reject deliveries whose timestamp drifts too far from your clock — that is the replay protection.
Delivery & retries
Deliveries time out after 10 seconds. Failures are retried with backoff; after 5 consecutive failures the endpoint is disabled automatically and you are notified — fix your endpoint and re-enable it from the same page. Every delivery’s outcome is visible in the endpoint’s history.
Respond 2xx quickly and process asynchronously — webhook handlers that do heavy work inline are the most common cause of disabled endpoints.