agency-board

POST `/v1/agency/boards/{boardId}/webhooks`

Add an outbound webhook.

ማረጋገጫ

የኤፒአይ ቁልፍ (API key) እንደ ቢረር ቶከን (bearer token) ይላኩ። ይህ የመጨረሻ ነጥብ (endpoint) በመግለጫው ውስጥ የተወሰነ ፈቃድ አልገለጸም፣ ስለዚህ ከማሰብ ይልቅ ለቁልፍዎ የሚያስፈልገውን አነስተኛ ፈቃድ ይስጡት እና ምላሹን ያረጋግጡ።

ይህ ኤንድፖይ መክፈቻ (endpoint) የድርጅት መታወቂያ (organisation id) አይወስድም። የእርስዎ ቁልፍ (key) እሱ የሚመለከተውን ድርጅት አስቀድሞ ይለያል፣ እና ምላሹም ለዚሁ የተወሰነ ነው።

ሞክሩት

በቅንፍ ውስጥ ያለውን ማንኛውንም ነገር በራስዎ እሴቶች ይተኩ፣ እና ቁልፍ ቦታ ያዢውን ከዳሽቦርድዎ በመጣ ቁልፍ ይተኩ።

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

ገብተዋል? የመቆጣጠሪያ ማዕከልዎ ውስጥ ያለው የኤፒአይ ኮንሶል ትክክለኛውን የድርጅት መታወቂያዎን እና የራስዎን ቁልፍ ይሞላል፣ እና ትክክለኛውን ምላሽ ማየት እንዲችሉ ጥያቄውን በቀጥታ ከሚሰራው ኤፒአይ ጋር ያካሂደዋል። ይህን ኤንድፖይንት በAPI ኮንሶል ውስጥ ይክፈቱ

ዝርዝሮች

HTTPS only. We mint the signing secret and return it **once, in this response**. There is no endpoint that can read it back, so keep it — rotate to get a new one. Deliveries are signed `X-Zinn-Signature: sha256=<hmac over "<timestamp>.<body>">` with `X-Zinn-Timestamp`, `X-Zinn-Delivery` and `X-Zinn-Event` beside them. The timestamp is bound INTO the signature so a captured request cannot be replayed for ever, and so a receiver cannot be tricked about which timestamp it was.

መለኪያዎች

ስም	ዓይነት	የሚያስፈልግ	ምንነቱ
`boardId (path)`	`Uuid`	አዎ	Project board ID (UUIDv7).

የጥያቄ አካል

ስም	ዓይነት	የሚያስፈልግ	ምንነቱ
`name`	`string`	አዎ	—
`url`	`string`	አዎ	HTTPS only. Private and link-local addresses are refused when the socket opens, not when you save.
`events`	`string[]`	አይ	Empty means every event this board emits.
`status`	`string<enabled, disabled>`	አይ	—

ምላሽ

ስም	ዓይነት	የሚያስፈልግ	ምንነቱ
`id`	`Uuid`	አዎ	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`board_id`	`Uuid`	አዎ	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`name`	`string`	አዎ	—
`url`	`string`	አዎ	—
`events`	`string[]`	አይ	—
`status`	`BoardAutomationStatus`	አዎ	`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`	አዎ	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`	አይ	—
`suspended_reason`	`string`	አይ	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`	አይ	—
`last_delivered_at`	`string`	አይ	—
`last_failed_at`	`string`	አይ	—
`created_at`	`string`	አይ	—
`secret`	`string`	አዎ	Shown ONCE, here. Store it now; rotate to get a new one.

ይህ ማብቂያ ሊመልሳቸው የሚችሉ ስህተቶች

401 · 403 · 404 · 422

POST /v1/agency/boards/{boardId}/webhooks