agency-board

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

Add an outbound webhook.

인증

Bearer 토큰으로 API 키를 전송하세요. 이 엔드포인트는 명세에 특정 권한을 명시하지 않으므로, 가정하기보다는 키에 필요한 최소한의 권한을 부여하고 응답을 확인하세요.

이 엔드포인트는 조직 ID를 받지 않습니다. 사용자의 키가 이미 속한 조직을 식별하며, 응답은 해당 조직으로 한정됩니다.

무료 체험하기

대괄호 안에 있는 모든 내용을 사용자 지정 값으로 바꾸고, 키 플레이스홀더는 대시보드의 키로 바꾸세요.

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 콘솔이 실제 조직 ID와 본인의 키를 자동으로 채우고 라이브 API를 대상으로 요청을 실행하므로 실제 응답을 확인할 수 있습니다. 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

인증