board-github
POST /v1/board-github/links/{linkId}/webhook
Try again to create the webhook on GitHub, and mint a fresh secret.
Autentikasi
Kirimkan kunci API sebagai token bearer. Titik akhir ini tidak menyatakan izin tertentu dalam spesifikasi, jadi berikan kunci Anda izin minimum yang diperlukan dan periksa responsnya alih-alih berasumsi.
Endpoint ini tidak memerlukan id organisasi. Kunci Anda telah mengidentifikasi organisasi tempatnya berafiliasi, dan respons akan dibatasi untuk organisasi tersebut.
Coba
Ganti apa pun di dalam tanda kurung sudut dengan nilai Anda sendiri, dan placeholder kunci dengan kunci dari dasbor Anda.
curl -X POST https://api.zinndigital.com/v1/board-github/links/{linkId}/webhook \
-H "Authorization: Bearer zdk_live_…"Sudah masuk? Konsol API di dasbor Anda akan mengisi ID organisasi asli dan kunci Anda sendiri, serta menjalankan permintaan terhadap API langsung sehingga Anda dapat melihat respons aktualnya. Buka titik akhir ini di konsol API
Detail
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.
Parameter
| Nama | Jenis | Wajib | Tentang apa ini |
|---|---|---|---|
linkId (path) | string | Ya | The GitHub Projects connection. |
Tanggapan
| Nama | Jenis | Wajib | Tentang apa ini |
|---|---|---|---|
state | GitHubWebhookState | Ya | 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 | Ya | The payload URL to paste into GitHub. |
secret | string | Tidak | 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[] | Ya | 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 | Tidak | Always `json`. GitHub's default is `form`, which this endpoint cannot read. |
Kesalahan yang dapat dikembalikan oleh titik akhir ini
401 · 403 · 404 · 422