Pular para o conteúdo principal
POST
Configurar webhook do GitHub
string
obrigatório
A chave da API para sua conta. Você pode encontrá-la nas configurações da conta.
Requer uma chave de API com o escopo apps:deploy. Este endpoint conecta uma aplicação a um repositório do GitHub da forma clássica: gere um token de acesso pessoal (formato ghp_* ou o formato refinado github_pat_*) e a Square Cloud retorna uma URL de webhook única para registrar nesse repositório, para que pushes disparem um deploy. Enviar access_token: "@" remove o webhook e o token de acesso existentes da aplicação. Configurar ou remover um webhook invalida a resposta em cache de Obter o deploy atual. As chamadas são limitadas a 5 por 60 segundos por usuário, e em aplicações compartilhadas em workspace, quem chama precisa da função admin ou ser o proprietário. Para revisar as tentativas de deploy disparadas por esse webhook, use Listar deploys. Um webhook e um vínculo do GitHub App podem ser configurados na mesma aplicação ao mesmo tempo: configurar um não remove o outro.

Parâmetros

string
obrigatório
O ID da aplicação. Você pode encontrá-lo na URL da sua aplicação no dashboard.
string
obrigatório
O token de acesso do seu repositório GitHub. Você pode encontrá-lo nos seus GitHub Tokens Classic

Resposta

string
Indica se a chamada foi bem-sucedida: success se foi, error se não.
object
O conteúdo da resposta.

Erros comuns

Entregas do webhook

O GitHub envia cada push para a URL do webhook (POST https://api.squarecloud.app/v2/git/webhook/{webhook}). A resposta é texto puro (text/plain) que diz se um deploy foi enfileirado, então a lista Recent Deliveries do webhook no GitHub mostra o que aconteceu com cada push. Apenas o 429 responde com JSON (KEEP_CALM). Um 200 só é enviado depois que o deploy foi armazenado na fila:
Todas as outras respostas terminam com Nothing was deployed. Todo 202 é respondido antes do limite de taxa, então não gasta o limite de 1 push a cada 15 segundos do webhook. Um release enviado com git push --follow-tags, ou um pull request mergeado cuja branch o GitHub exclui automaticamente, não segura mais o deploy do push da branch que chega junto. Para uma tag ou uma branch excluída, a resposta começa com o código, como aparece no GitHub em Settings > Webhooks > Recent Deliveries, na aba Response:
Se uma entrega mostrar 503, reenvie-a no GitHub em Settings > Webhooks > Recent Deliveries, ou faça push novamente.

Relacionados