board-github
POST /v1/board-github/webhook/{endpointKey}
One GitHub webhook delivery for a linked project.
Аутентификација
Ова крајња тачка је јавна. Не захтева никакве акредитиве нити организацију — то је оно што читају наш сопствени маркетиншки сајт и машине за одговоре са вештачком интелигенцијом.
Ова крајња тачка не прихвата id организације. Ваш кључ већ идентификује организацију којој припада, а одговор је ограничен на њу.
Испробајте
Замените све што је у угластим заградама сопственим вредностима, а чувар места кључа кључем са своје контролне табле.
curl -X POST https://api.zinndigital.com/v1/board-github/webhook/{endpointKey}Пријављени сте? API конзола на вашој контролној табли попуњава ваш прави id организације и ваш сопствени кључ, и покреће захтев према живом 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… |
Одговор
| Назив | Тип | Обавезно | Шта је ово |
|---|---|---|---|
accepted | boolean | Да | — |
reason | string | Не | Why a valid delivery was not acted on (ping, an unhandled event, an unlinked project). |
link_id | string | Не | — |
queued | boolean | Не | — |
Грешке које ова крајња тачка може вратити
401