board-github
POST /v1/board-github/links/{linkId}/webhook
Try again to create the webhook on GitHub, and mint a fresh secret.
Autentizace
Odešlete klíč API jako bearer token. Tento koncový bod ve specifikaci uvádí specifické oprávnění, takže svému klíči udělte to nejmenší možné a místo předpokladů zkontrolujte odpověď.
Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.
Vyzvednout
Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.
curl -X POST https://api.zinndigital.com/v1/board-github/links/{linkId}/webhook \
-H "Authorization: Bearer zdk_live_…"Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API
Podrobnosti
For the customer who has just granted the permission that was missing, and for rotating a secret that has been shown to somebody it should not have been. **The secret changes on every call**, so a hook the customer created by hand stops verifying until they paste the new one — which is why the response says which state resulted.
Parametry
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
linkId (path) | string | Ano | The GitHub Projects connection. |
Odpověď
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
state | GitHubWebhookState | Ano | Whether GitHub pushes changes at us, and if not, whose move it is. **Three outcomes and not a boolean.** `automatic` — we created the organisation webhook. `manual` — GitHub wou… |
url | string | Ano | The payload URL to paste into GitHub. |
secret | string | Ne | The signing secret, returned **only** for a connection the customer must configure themselves. Empty for an App connection, which is signed with the platform app's own secret an… |
events | string[] | Ano | The events the hook must subscribe to. `projects_v2_item` alone is not enough: renaming or closing the project emits `projects_v2`, and a board whose title is stale until the ne… |
content_type | string | Ne | Always `json`. GitHub's default is `form`, which this endpoint cannot read. |
Chyby, které může tento koncový bod vrátit
401 · 403 · 404 · 422