board-github
POST /v1/board-github/links/{linkId}/webhook
Try again to create the webhook on GitHub, and mint a fresh secret.
Автентифікація
Надішліть ключ API як маркер носія (bearer token). Ця кінцева точка не вказує конкретного дозволу в специфікації, тому надайте своєму ключу мінімально необхідні права та перевірте відповідь, замість того щоб припускати.
Цей кінцевий пункт не потребує ідентифікатора організації. Ваш ключ уже ідентифікує організацію, якій він належить, і відповідь обмежується її межами.
Спробувати
Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.
curl -X POST https://api.zinndigital.com/v1/board-github/links/{linkId}/webhook \
-H "Authorization: Bearer zdk_live_…"Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API
Деталі
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.
Параметри
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
linkId (path) | string | Так | The GitHub Projects connection. |
Відповідь
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
state | GitHubWebhookState | Так | 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 would… |
url | string | Так | The payload URL to paste into GitHub. |
secret | string | Ні | 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 and… |
events | string[] | Так | 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 next… |
content_type | string | Ні | Always json. GitHub's default is form, which this endpoint cannot read. |
Помилки, які може повертати ця кінцева точка
401 · 403 · 404 · 422