ads
GET /v1/ads/webhooks
The org's webhook endpoints and the Zinn® Ads events each one receives (za-192).
Authentication
Send an API key as a bearer token. The key must carry the ads.view permission; a key without it is refused with 403, not 404.
Where your organisation id goes
This endpoint takes org_id as a query parameter. Leave it out and the call covers your whole tenancy subtree; send it to narrow the call to one organisation.
Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X GET https://api.zinndigital.com/v1/ads/webhooks \
-H "Authorization: Bearer zdk_live_…"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
Gated on ads.view. Lists every organisation-level webhook notification connection (created at POST /v1/notification-connections with kind: webhook: HTTPS only, a signing secret we mint, verified by a real test POST) with the Zinn® Ads events it is subscribed to. The event shapes are this spec's top-level webhooks section (ads.finding.opened, ads.change.applied, ads.alert.started). Every delivery is signed X-Zinn-Signature: sha256=<hmac-sha256 over "<X-Zinn-Timestamp>.<raw body>">, carries X-Zinn-Delivery (dedupe on it) and X-Zinn-Event, is retried 1, 5, 25, 125 and 625 minutes after a failure and appears in GET /v1/notification-connections/{id}/deliveries. Read from our own rows (docs/1006 §70).
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
org_id (query) | string | No | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
data | AdsWebhooks | Yes | — |
Errors this endpoint can return
401 · 403 · 404 · 422 · 429