API Reference

Webhook deliveries

Operate delivery handling, deduplication, failures, and manual resend.

Delivery statuses

NameTypeDescription
PENDINGin progressDelivery was created and has not reached a final outcome.
DELIVEREDterminalThe endpoint returned an HTTP 2xx response.
FAILEDterminalThe request timed out, could not connect, or returned a non-2xx response.
DLQreservedDefined for dead-letter handling, but current finalization writes DELIVERED or FAILED.

Response requirements

  • Respond with HTTP 2xx for success.
  • Default delivery timeout is 10 seconds (WEBHOOK_DELIVERY_TIMEOUT_MS).
  • Content-Type of the Zippy request is application/json; charset=utf-8.

Retries and DLQ

Ordering and deduplication

Deduplicate on envelope id and/or X-Zippy-Delivery-Id.

Operational checklist

  • Monitor FAILED deliveries in Developer → Webhook Event.
  • Alert on sustained non-2xx or timeout spikes.
  • Keep receivers idempotent before enabling more event types.