board-github
GET /v1/board-github/links/{linkId}/webhook
The payload URL and signing secret for a connection the customer configures.
Аутентификација
Пошаљите API кључ као bearer токен. Ова крајња тачка не наводи конкретну дозволу у спецификацији, па свом кључу доделите најмања неопходна овлашћења и проверите одговор уместо да претпостављате.
Ова крајња тачка не прихвата id организације. Ваш кључ већ идентификује организацију којој припада, а одговор је ограничен на њу.
Испробајте
Замените све што је у угластим заградама сопственим вредностима, а чувар места кључа кључем са своје контролне табле.
curl -X GET https://api.zinndigital.com/v1/board-github/links/{linkId}/webhook \
-H "Authorization: Bearer zdk_live_…"Пријављени сте? API конзола на вашој контролној табли попуњава ваш прави id организације и ваш сопствени кључ, и покреће захтев према живом API-ју како бисте могли да видите стварни одговор. Отворите ову крајњу тачку у 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