board-github
POST /v1/board-github/webhook/{endpointKey}
One GitHub webhook delivery for a linked project.
身份验证
此端点是公开的。它不需要任何凭据或组织——这是我们自己的营销网站和 AI 问答引擎所读取的内容。
此端点不需要组织 ID。您的密钥已用于识别其所属的组织,且响应范围也仅限于该组织。
免费试用
将尖括号中的内容替换为您自己的值,并将键占位符替换为您仪表板中的一个键。
curl -X POST https://api.zinndigital.com/v1/board-github/webhook/{endpointKey}已登录?您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥,并针对实时 API 运行请求,以便您查看实际的响应。 在 API 控制台中打开此端点
详细信息
**Public and unauthenticated — the HMAC is the authentication.** GitHub cannot present a session, so `X-Hub-Signature-256` over the raw body with this connection's own secret is the whole control. Answers **202 for every valid delivery, including ones we do not act on** — a ping, or an event type we ignore. Answering those with an error paints the endpoint permanently red on the customer's own GitHub screen, so a working integration looks broken; the `reason` field says which. A bad or absent signature is **401 with an empty body**: a response that distinguished "no such endpoint" from "wrong secret" would be an oracle for guessing endpoint keys.
参数
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
endpointKey (path) | string | 是 | The connection's opaque endpoint key, or `app` for the platform GitHub App's own shared webhook. Not the connection's id — a URL the customer pastes into GitHub ends up in their… |
响应
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
accepted | boolean | 是 | — |
reason | string | 否 | Why a valid delivery was not acted on (`ping`, an unhandled event, an unlinked project). |
link_id | string | 否 | — |
queued | boolean | 否 | — |
此端点可能返回的错误
401