REFERENCE · DELIVERY
PUT /v1/delivery
Full delivery config. webhook (url, events list or ["*"], default document.* + verdict.*; returns secret once) and/or batch (schedule, hour_utc for daily, format, events, include_snapshot, destination).
PARAMETERS
| NAME | TYPE | REQUIRED | DESCRIPTION |
|---|---|---|---|
| Idempotency-Key | string | no | Optional, and the preferred way to make a retry safe. Send one on every POST and PUT; a replay returns the original response with idempotent_replay true and creates nothing new. POST /documents also accepts an idempotency_key form field as an alias; the header wins when both are sent |
| webhook | object | no | One webhook endpoint per verifying entity. Default subscription if omitted: document.* and verdict.* |
| batch | object | no | One scheduled batch export per verifying entity |
| recent_batch_runs | object[] | no | Present on GET /delivery |
RESPONSE
| FIELD | TYPE | DESCRIPTION |
|---|---|---|
| webhook | object | One webhook endpoint per verifying entity. Default subscription if omitted: document.* and verdict.* |
| batch | object | One scheduled batch export per verifying entity |
| recent_batch_runs | object[] | Present on GET /delivery |
Errors: 400, 401, 403, 409, 422, 429, 500. Every error body carries error.code, error.message, and error.request_id.