board-github
GET /v1/board-github/links/{linkId}/webhook
The payload URL and signing secret for a connection the customer configures.
تصدیقهویت
د بیارر ټوکن په توګه یو API کي وسپارئ. دا پای ټکی په مشخصاتو کې کوم ځانګړی اجازه لیک نه بیانوي، نو خپل کیلي ته لږترلږه هغه څه ورکړئ چې ورته اړتیا لري او د فرض کولو پر ځای ځواب وپلټئ.
دا پای نقطه د سازمان هېڅ آی ډي نه اخلي. ستاسو کیلي مخکې تر مخکې هغه سازمان په ګوته کوي چې پورې اړه لري، او ځواب ورته محدود دی.
هڅه وکړئ
د انګلیسي په زاوي پنسونو کې هرڅه د خپلو ارزښتونو سره بدل کړئ، او د کلي ځای لرونکی ستاسو د ډشبورډ د کلي سره.
curl -X GET https://api.zinndigital.com/v1/board-github/links/{linkId}/webhook \
-H "Authorization: Bearer zdk_live_…"ننوتي یاست؟ ستاسو په ډشبورډ کې د API کنسول ستاسو د اصلي سازمان ID او ستاسو خپله کیلي ډکوي، او غوښتنه د ژوندی API په وړاندې پرمخ وړي ترڅو تاسو وکولی شئ اصلي ځواب وګورئ. دا پای ټکی (endpoint) د API په کنسول کې پرانیزئ
تفصیلات
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.
پارامترونه
| نوم | ډول | اړین | دا څه شی دی |
|---|---|---|---|
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