agency-board

PATCH `/v1/agency/boards/{boardId}/webhooks/{webhookId}`

Change a webhook, or pause and resume it.

Authenticatie

Stuur een API-sleutel mee als bearer token. Dit eindpunt vermeldt geen specifieke toestemming in de specificatie, dus geef uw sleutel de minimale rechten die nodig zijn en controleer het antwoord in plaats van zomaar wat aan te nemen.

Dit eindpunt vereist geen organisatie-id. Uw sleutel identificeert al de organisatie waartoe deze behoort, en het antwoord is hierop afgestemd.

Probeer het

Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw dashboard.

curl -X PATCH https://api.zinndigital.com/v1/agency/boards/{boardId}/webhooks/{webhookId} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "name": <string>, "url": <string> }'

Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de API-console

Parameters

Naam	Type	Verplicht	Wat dit is
`boardId (path)`	`Uuid`	Ja	Project board ID (UUIDv7).
`webhookId (path)`	`Uuid`	Ja	Outbound webhook subscription ID (UUIDv7).

Aanvraaglichaam

Naam	Type	Verplicht	Wat dit is
`name`	`string`	Ja	—
`url`	`string`	Ja	HTTPS only. Private and link-local addresses are refused when the socket opens, not when you save.
`events`	`string[]`	Nee	Empty means every event this board emits.
`status`	`string<enabled, disabled>`	Nee	—

Reactie

Naam	Type	Verplicht	Wat dit is
`id`	`Uuid`	Ja	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`board_id`	`Uuid`	Ja	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`name`	`string`	Ja	—
`url`	`string`	Ja	—
`events`	`string[]`	Nee	—
`status`	`BoardAutomationStatus`	Ja	`suspended` means WE paused it after repeated failure and it carries a reason the customer has not read. It is a third state rather than a reuse of `disabled`, because collapsin…
`has_secret`	`boolean`	Ja	Whether a signing secret is stored. The secret itself is in Vault and is returned only by create and rotate; no endpoint can read it back.
`consecutive_failures`	`integer`	Nee	—
`suspended_reason`	`string`	Nee	Why we paused this webhook, in authored copy from a closed table — never an exception from our own code. It distinguishes your endpoint refusing a delivery, your endpoint being…
`suspended_at`	`string`	Nee	—
`last_delivered_at`	`string`	Nee	—
`last_failed_at`	`string`	Nee	—
`created_at`	`string`	Nee	—

Fouten die dit eindpunt kan retourneren

401 · 403 · 404 · 422

PATCH /v1/agency/boards/{boardId}/webhooks/{webhookId}