board-github
GET /v1/board-github/links/{linkId}/webhook
The payload URL and signing secret for a connection the customer configures.
Kimlik Doğrulama
Bir API anahtarını bearer token olarak gönderin. Bu uç nokta, teknik özelliklerde belirli bir yetki belirtmemektedir; bu nedenle, varsaymak yerine anahtarınıza ihtiyaç duyduğu en az yetkiyi verin ve yanıtı kontrol edin.
Bu uç nokta hiçbir organizasyon kimliği almaz. Anahtarınız zaten ait olduğu organizasyonu tanımlar ve yanıt bu organizasyonla sınırlandırılır.
Dene
Köşeli parantez içindeki her şeyi kendi değerlerinizle ve anahtar yer tutucusunu panonuzdan bir anahtarla değiştirin.
curl -X GET https://api.zinndigital.com/v1/board-github/links/{linkId}/webhook \
-H "Authorization: Bearer zdk_live_…"Oturum açtınız mı? Panonuzdaki API konsolu, gerçek organizasyon kimliğinizi ve kendi anahtarınızı otomatik olarak doldurur ve isteği canlı API üzerinde çalıştırarak gerçek yanıtı görmenizi sağlar. Bu uç noktayı API konsolunda açın
Ayrıntılar
Read when webhook_state is manual, which is the commonest case: creating an organisation webhook needs a permission most customers will not grant, so they create it themselves and this is what they need to do it. The secret is returned in full — there is no way to configure a webhook without it — so the read is audit-logged and requires the manage permission rather than the view one. An App connection returns an empty secret because it is signed with the platform app's own, and there is nothing for the customer to set up.
Parametreler
| Ad | Tür | Zorunlu | Ne olduğu |
|---|---|---|---|
linkId (path) | string | Evet | The GitHub Projects connection. |
Yanıt
| Ad | Tür | Zorunlu | Ne olduğu |
|---|---|---|---|
state | GitHubWebhookState | Evet | 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 | Evet | The payload URL to paste into GitHub. |
secret | string | Hayır | 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[] | Evet | 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 | Hayır | Always json. GitHub's default is form, which this endpoint cannot read. |
Bu uç noktanın dönderebileceği hatalar
401 · 403 · 404