agency-board

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

Add an outbound webhook.

การยืนยันตัวตน

ส่ง API key เป็น bearer token เอนด์พอยต์นี้ไม่ได้ระบุสิทธิ์การใช้งานเฉพาะในข้อกำหนด ดังนั้นควรให้คีย์ของคุณมีสิทธิ์น้อยที่สุดเท่าที่จำเป็นและให้ตรวจสอบจากการตอบกลับแทนที่จะคาดเดา

ปลายทางนี้ไม่ต้องใช้รหัสองค์กร คีย์ของคุณระบุองค์กรที่เป็นเจ้าของอยู่แล้ว และการตอบกลับจะถูกจำกัดขอบเขตไว้เฉพาะองค์กรนั้น

ทดลองใช้เลย

แทนที่สิ่งใดๆ ที่อยู่ภายในวงเล็บแหลมด้วยค่าของคุณเอง และตัวยึดตำแหน่งคีย์ด้วยคีย์จากแดชบอร์ดของคุณ

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 ในแดชบอร์ดของคุณจะเติมรหัสองค์กรจริงและคีย์ของคุณเองโดยอัตโนมัติ และทำการส่งคำขอไปยัง 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 collapsing…
`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