agency-board

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

Change a webhook, or pause and resume it.

Autenticazione

Invia una chiave API come bearer token. Questo endpoint non specifica un permesso specifico nella specifica, quindi assegna alla tua chiave i permessi minimi necessari e verifica la risposta invece di fare supposizioni.

Questo endpoint non richiede alcun ID organizzazione. La tua chiave identifica già l'organizzazione a cui appartiene e la risposta è limitata ad essa.

Provalo

Sostituisci qualsiasi elemento tra parentesi angolari con i tuoi valori e il segnaposto key con una chiave dalla tua 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> }'

Hai effettuato l'accesso? La console API nella tua dashboard inserisce il tuo ID organizzazione reale e la tua chiave personale, ed esegue la richiesta sull'API live in modo da poter vedere la risposta effettiva. Apri questo endpoint nella console API

Parametri

Nome	Tipo	Obbligatorio	Che cos'è
`boardId (path)`	`Uuid`	Sì	Project board ID (UUIDv7).
`webhookId (path)`	`Uuid`	Sì	Outbound webhook subscription ID (UUIDv7).

Corpo della richiesta

Nome	Tipo	Obbligatorio	Che cos'è
`name`	`string`	Sì	—
`url`	`string`	Sì	HTTPS only. Private and link-local addresses are refused when the socket opens, not when you save.
`events`	`string[]`	No	Empty means every event this board emits.
`status`	`string<enabled, disabled>`	No	—

Risposta

Nome	Tipo	Obbligatorio	Che cos'è
`id`	`Uuid`	Sì	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`board_id`	`Uuid`	Sì	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`name`	`string`	Sì	—
`url`	`string`	Sì	—
`events`	`string[]`	No	—
`status`	`BoardAutomationStatus`	Sì	`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`	Sì	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`	No	—
`suspended_reason`	`string`	No	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`	No	—
`last_delivered_at`	`string`	No	—
`last_failed_at`	`string`	No	—
`created_at`	`string`	No	—

Errori che questo endpoint può restituire

401 · 403 · 404 · 422

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