agency-board

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

Change a webhook, or pause and resume it.

Autentificare

Trimiteți o cheie API ca token de tip bearer. Acest punct final nu specifică o permisiune anume în specificație, așa că acordați cheii cele mai puține drepturi necesare și verificați răspunsul în loc să faceți presupuneri.

Acest endpoint nu necesită un ID de organizație. Cheia ta identifică deja organizația căreia îi aparține, iar răspunsul este limitat la aceasta.

Încearcă

Înlocuiți tot ce se află între paranteze unghiulare cu propriile valori și substituentul cheie cu o cheie din tabloul de bord.

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> }'

Autentificat? Consola API din panoul de control îți completează ID-ul real al organizației și propria cheie și rulează cererea în API-ul live, astfel încât să poți vedea răspunsul efectiv. Deschideți acest punct final în consola API

Parametri

Nume	Tip	Obligatoriu	Ce este
`boardId (path)`	`Uuid`	Da	Project board ID (UUIDv7).
`webhookId (path)`	`Uuid`	Da	Outbound webhook subscription ID (UUIDv7).

Corp cerere

Nume	Tip	Obligatoriu	Ce este
`name`	`string`	Da	—
`url`	`string`	Da	HTTPS only. Private and link-local addresses are refused when the socket opens, not when you save.
`events`	`string[]`	Nu	Empty means every event this board emits.
`status`	`string<enabled, disabled>`	Nu	—

Răspuns

Nume	Tip	Obligatoriu	Ce este
`id`	`Uuid`	Da	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`board_id`	`Uuid`	Da	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`name`	`string`	Da	—
`url`	`string`	Da	—
`events`	`string[]`	Nu	—
`status`	`BoardAutomationStatus`	Da	`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`	Da	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`	Nu	—
`suspended_reason`	`string`	Nu	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`	Nu	—
`last_delivered_at`	`string`	Nu	—
`last_failed_at`	`string`	Nu	—
`created_at`	`string`	Nu	—

Erori pe care le poate returna acest punct final

401 · 403 · 404 · 422

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