mail

POST /v1/webhooks/mail-relay-events

Ingest signed delivery events from our own mail relay.

All mail endpoints

All developer docs

Authentication

This endpoint is public. It takes no credential and no organisation — it is what our own marketing site and AI answer engines read.

This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X POST https://api.zinndigital.com/v1/webhooks/mail-relay-events \
  -H "Content-Type: application/json" \
  -d '{ "events": <object[]> }'

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

Unauthenticated by design: the relay holds no Zinn® credential, so x-signature: base64(HMAC-SHA256(secret, raw body)) is the authentication. Counts remote deliveries and permanent refusals per mailbox, and suspends sending on a mailbox whose last 24 hours are at least 50 refusals and at least 20% of its outcomes. With no configured secret it answers 503 and counts nothing. Events older than two hours are ignored, so a captured request replayed later changes nothing.

Parameters

NameTypeRequiredWhat it is
x-signature (header)stringYes

Request body

NameTypeRequiredWhat it is
eventsobject[]Yes

Response

NameTypeRequiredWhat it is
receivedintegerYes
countedintegerYes
ignoredintegerYes
unknown_sendersintegerYes
suspendedintegerYes

Errors this endpoint can return

400 · 503