board-github

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

One GitHub webhook delivery for a linked project.

Все эндпоинты board-github

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

Аутентификация

Этот эндпоинт является публичным. Он не требует учетных данных и организации — его читают наш собственный маркетинговый сайт и поисковые системы на базе ИИ.

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

Попробовать

Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.

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

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

Ответ

ИмяТипОбязательноЧто это
acceptedbooleanДа
reasonstringНетWhy a valid delivery was not acted on (ping, an unhandled event, an unlinked project).
link_idstringНет
queuedbooleanНет

Ошибки, которые может возвращать этот эндпоинт

401