agency-board

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

Change a webhook, or pause and resume it.

Sve agency-board krajnje tačke

Autentifikacija

Pošaljite API ključ kao bearer token. Ova krajnja tačka ne navodi specifičnu dozvolu u specifikaciji, zato dodelite svom ključu minimum potrebnih ovlašćenja i proverite odgovor umesto da pretpostavljate.

Ovaj krajnji tačka ne prihvata ID organizacije. Vaš ključ već identifikuje organizaciju kojoj pripada, a odgovor je ograničen na nju.

Isprobajte

Zamenite bilo šta u uglastim zagradama sopstvenim vrednostima, a ključni placeholder sa ključem sa vaše kontrolne table.

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

Prijavljeni ste? API konzola na vašoj kontrolnoj tabli automatski popunjava ID vaše stvarne organizacije i vaš sopstveni ključ, i izvršava zahtev nad API-jem uživo tako da možete videti stvarni odgovor. Otvorite ovu krajnju tačku u API konzoli

Parametri

NazivVrstaObaveznoŠta je ovo
boardId (path)UuidDaProject board ID (UUIDv7).
webhookId (path)UuidDaOutbound webhook subscription ID (UUIDv7).

Telo zahteva

NazivVrstaObaveznoŠta je ovo
namestringDa
urlstringDaHTTPS only. Private and link-local addresses are refused when the socket opens, not when you save.
eventsstring[]NeEmpty means every event this board emits.
statusstring<enabled, disabled>Ne

Odgovor

NazivVrstaObaveznoŠta je ovo
idUuidDaUUIDv7 identifier — sortable by creation time (docs/02 §8).
board_idUuidDaUUIDv7 identifier — sortable by creation time (docs/02 §8).
namestringDa
urlstringDa
eventsstring[]Ne
statusBoardAutomationStatusDa`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_secretbooleanDaWhether 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_failuresintegerNe
suspended_reasonstringNeWhy 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_atstringNe
last_delivered_atstringNe
last_failed_atstringNe
created_atstringNe

Greške koje ovaj krajnji tačka može da vrati

401 · 403 · 404 · 422