agency-board

POST `/v1/board-hooks/{endpointKey}`

The public inbound door — n8n, Zapier, Make, GitHub.

身份验证

此端点是公开的。它不需要任何凭据或组织——这是我们自己的营销网站和 AI 问答引擎所读取的内容。

此端点不需要组织 ID。您的密钥已用于识别其所属的组织，且响应范围也仅限于该组织。

免费试用

将尖括号中的内容替换为您自己的值，并将键占位符替换为您仪表板中的一个键。

curl -X POST https://api.zinndigital.com/v1/board-hooks/{endpointKey} \
  -H "Content-Type: application/json" \
  -d '{  }'

已登录？您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥，并针对实时 API 运行请求，以便您查看实际的响应。在 API 控制台中打开此端点

详细信息

**Unauthenticated by design: the HMAC signature IS the authentication**, exactly as `/v1/webhooks/stripe` is. Send `X-Zinn-Signature: sha256=<hmac-sha256 over "<timestamp>.<raw body>">` and `X-Zinn-Timestamp` (unix seconds, within five minutes of now), signed with the endpoint's secret. The body must be a JSON object. Five top-level values — `event`, `status`, `title`, `body`, `ref` — are projected into the rule's condition surface as `payload_*`, so a rule can branch on them. Anything else in the body is stored in the request log and is not conditionable. ⛔ An unknown endpoint key and a bad signature both answer **404 with the same body**, deliberately: distinguishing them would turn this into an oracle for whether a key exists. The endpoint's OWNER sees the real reason on their own screen.

参数

名称	类型	必填	内容简介
`endpointKey (path)`	`string`	是	The endpoint's opaque key — 32 hex characters. Deliberately not the board id: a board id in a URL customers paste into third-party systems leaks an internal identifier into some…

请求正文

名称	类型	必填	内容简介
`event`	`string`	否	—
`status`	`string`	否	—
`title`	`string`	否	—
`body`	`string`	否	—
`ref`	`string`	否	—

响应

名称	类型	必填	内容简介
`accepted`	`boolean`	是	—
`rules_fired`	`integer`	否	—
`detail`	`string`	否	—

此端点可能返回的错误

404 · 409 · 413 · 429

POST /v1/board-hooks/{endpointKey}