Guide

Webhooks

Subscribe to events, verify signatures, and replay failed deliveries.

Create a subscription

POST /api/v1/webhooks with an HTTPS endpoint and the events you need. Required scope: webhooks:write.

curl https://api.statxe.com/api/v1/webhooks \
  -X POST \
  -H "Authorization: Bearer stx_live_xxx" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: webhook_primary_prod" \
  -d '{
    "name": "Production events",
    "url": "https://example.com/api/statxe/webhooks",
    "events": ["contact.created", "email.delivered", "email.bounced"]
  }'

Verify signatures

Every delivery includes a signed header. Verify the timestamped signature before trusting the payload. Store event or delivery ids so retries are processed once.

Replay

List deliveries with GET /api/v1/webhooks/deliveries and replay a failed delivery with POST /api/v1/webhooks/deliveries/{id}/replay when your endpoint is healthy again.