board-github
POST /v1/board-github/webhook/{endpointKey}
One GitHub webhook delivery for a linked project.
Autenticazione
Questo endpoint è pubblico. Non richiede credenziali né alcuna organizzazione: è ciò che leggono il nostro sito di marketing e i nostri motori di risposta basati su IA.
Questo endpoint non richiede alcun ID organizzazione. La tua chiave identifica già l'organizzazione a cui appartiene e la risposta è limitata ad essa.
Provalo
Sostituisci qualsiasi elemento tra parentesi angolari con i tuoi valori e il segnaposto key con una chiave dalla tua dashboard.
curl -X POST https://api.zinndigital.com/v1/board-github/webhook/{endpointKey}Hai effettuato l'accesso? La console API nella tua dashboard inserisce il tuo ID organizzazione reale e la tua chiave personale, ed esegue la richiesta sull'API live in modo da poter vedere la risposta effettiva. Apri questo endpoint nella console API
Dettagli
**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.
Parametri
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
endpointKey (path) | string | Sì | 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… |
Risposta
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
accepted | boolean | Sì | — |
reason | string | No | Why a valid delivery was not acted on (`ping`, an unhandled event, an unlinked project). |
link_id | string | No | — |
queued | boolean | No | — |
Errori che questo endpoint può restituire
401