agency-board

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

Change a webhook, or pause and resume it.

Hitelesítés

Küldjön egy API-kulcsot bearer tokenként. Ez a végpont nem határoz meg konkrét jogosultságot a specifikációban, ezért adja meg a kulcsnak a legkevesebbet, amire szüksége van, és a feltételezés helyett ellenőrizze a választ.

Ez a végpont nem fogad el szervezeti azonosítót. Az Ön kulcsa már azonosítja azt a szervezetet, amelyhez tartozik, és a válasz is erre vonatkozik.

Próbálja ki

Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.

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

Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban

Paraméterek

Név	Típus	Kötelező	Mi ez
`boardId (path)`	`Uuid`	Igen	Project board ID (UUIDv7).
`webhookId (path)`	`Uuid`	Igen	Outbound webhook subscription ID (UUIDv7).

Kérés törzse

Név	Típus	Kötelező	Mi ez
`name`	`string`	Igen	—
`url`	`string`	Igen	HTTPS only. Private and link-local addresses are refused when the socket opens, not when you save.
`events`	`string[]`	Nem	Empty means every event this board emits.
`status`	`string<enabled, disabled>`	Nem	—

Válasz

Név	Típus	Kötelező	Mi ez
`id`	`Uuid`	Igen	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`board_id`	`Uuid`	Igen	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`name`	`string`	Igen	—
`url`	`string`	Igen	—
`events`	`string[]`	Nem	—
`status`	`BoardAutomationStatus`	Igen	`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`	Igen	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`	Nem	—
`suspended_reason`	`string`	Nem	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`	Nem	—
`last_delivered_at`	`string`	Nem	—
`last_failed_at`	`string`	Nem	—
`created_at`	`string`	Nem	—

Hibák, amelyeket ez a végpont visszaadhattatlan

401 · 403 · 404 · 422

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