board-github

POST /v1/board-github/webhook/{endpointKey}

One GitHub webhook delivery for a linked project.

Wszystkie punkty końcowe board-github

Wszystkie dokumentacje dla programistów

Uwierzytelnianie

Ten punkt końcowy jest publiczny. Nie wymaga żadnych poświadczeń ani organizacji — to z niego korzysta nasza własna strona marketingowa oraz silniki odpowiedzi AI.

Ten punkt końcowy nie wymaga identyfikatora organizacji. Twój klucz już identyfikuje organizację, do której należy, a odpowiedź jest do niej ograniczona.

Wypróbuj

Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.

curl -X POST https://api.zinndigital.com/v1/board-github/webhook/{endpointKey}

Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API

Szczegóły

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.

Parametry

NazwaTypWymaganeCo to jest
endpointKey (path)stringTakThe 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…

Odpowiedź

NazwaTypWymaganeCo to jest
acceptedbooleanTak
reasonstringNieWhy a valid delivery was not acted on (ping, an unhandled event, an unlinked project).
link_idstringNie
queuedbooleanNie

Błędy, które ten punkt końcowy może zwrócić

401