board-github

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

One GitHub webhook delivery for a linked project.

Всички крайни точки в board-github

Всички документи за разработчици

Упълномощаване

Този крайpoint е публичен. Той не изисква данни за удостоверяване и организация — това е съдържанието, което нашият собствен маркетинг сайт и AI машини за отговори четат.

Този ендпойнт не изисква идентификатор на организация. Вашият ключ вече идентифицира организацията, към която принадлежи, и отговорът е ограничен до нея.

Опитайте

Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.

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

Влязохте ли в профила си? API конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в 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…

Отговор

ИмеТипЗадължителноКакво представлява
acceptedbooleanДа
reasonstringНеWhy a valid delivery was not acted on (ping, an unhandled event, an unlinked project).
link_idstringНе
queuedbooleanНе

Грешки, които този крайpoint може да върне

401