board-github
POST /v1/board-github/webhook/{endpointKey}
One GitHub webhook delivery for a linked project.
Pagpapatotoo
Ang endpoint na ito ay pampubliko. Wala itong kinukuha na kredensyal at organisasyon — ito ang binabasa ng aming sariling marketing site at mga AI answer engine.
Ang endpoint na ito ay hindi nangangailangan ng id ng organisasyon. Natutukoy na ng iyong key ang organisasyong kinabibilangan nito, at nakatuon ang tugon dito.
Subukan ito
Palitan ang anuman sa loob ng mga panaklong na may anggulo ng iyong sariling mga halaga, at ang placeholder ng key na may key mula sa iyong dashboard.
curl -X POST https://api.zinndigital.com/v1/board-github/webhook/{endpointKey}Nakalagda? Ang API console sa iyong dashboard ay awtomatikong naglalagay ng iyong tunay na ID ng organisasyon at sariling susi, at pinapatakbo ang kahilingan laban sa live na API upang makita mo ang aktwal na tugon. Buksan ang endpoint na ito sa console ng API
Mga Detalye
**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.
Mga Parameter
| Pangalan | Uri | Kailangan | Ano ito |
|---|---|---|---|
endpointKey (path) | string | Oo | 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… |
Tugon
| Pangalan | Uri | Kailangan | Ano ito |
|---|---|---|---|
accepted | boolean | Oo | — |
reason | string | Hindi | Why a valid delivery was not acted on (`ping`, an unhandled event, an unlinked project). |
link_id | string | Hindi | — |
queued | boolean | Hindi | — |
Mga error na maibabalik ng endpoint na ito
401