board-github
GET /v1/board-github/links/{linkId}/webhook
The payload URL and signing secret for a connection the customer configures.
Autenticação
Envie uma chave de API como um token bearer. Este endpoint não especifica uma permissão específica na documentação, portanto, conceda à sua chave o mínimo necessário e verifique a resposta em vez de assumir.
Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.
Experimente
Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.
curl -X GET https://api.zinndigital.com/v1/board-github/links/{linkId}/webhook \
-H "Authorization: Bearer zdk_live_…"Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API
Detalhes
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.
Parâmetros
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
linkId (path) | string | Sim | The GitHub Projects connection. |
Resposta
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
state | GitHubWebhookState | Sim | 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 | Sim | The payload URL to paste into GitHub. |
secret | string | Não | 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[] | Sim | 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 | Não | Always `json`. GitHub's default is `form`, which this endpoint cannot read. |
Erros que este endpoint pode retornar
401 · 403 · 404