Configurar webhook do GitHub

POST

apps

{app_id}

deploy

webhook

Configurar webhook do GitHub

curl --request POST \
  --url https://api.squarecloud.app/v2/apps/{app_id}/deploy/webhook \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "access_token": "<string>"
}
'

import requests

url = "https://api.squarecloud.app/v2/apps/{app_id}/deploy/webhook"

payload = { "access_token": "<string>" }
headers = {
    "Authorization": "<authorization>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
  body: JSON.stringify({access_token: '<string>'})
};

fetch('https://api.squarecloud.app/v2/apps/{app_id}/deploy/webhook', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.squarecloud.app/v2/apps/{app_id}/deploy/webhook",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'access_token' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.squarecloud.app/v2/apps/{app_id}/deploy/webhook"

	payload := strings.NewReader("{\n  \"access_token\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<authorization>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.squarecloud.app/v2/apps/{app_id}/deploy/webhook")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "application/json")
  .body("{\n  \"access_token\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.squarecloud.app/v2/apps/{app_id}/deploy/webhook")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"access_token\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
    "status": "success",
    "response": {
        "webhook": "https://api.squarecloud.app/v2/git/webhook/<webhook-code>"
    }
}

string

obrigatório

A chave da API para sua conta. Você pode encontrá-la nas configurações da conta.

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 uma implantação. 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 implantação 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 Administrador ou ser o proprietário. Para revisar as tentativas de implantação disparadas por esse webhook, use Listar implantações. 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 do painel da sua aplicação.

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 bem-sucedida, error se não.

object

O conteúdo da resposta.

Mostrar Alternar objeto

string

A URL do webhook.

{
    "status": "success",
    "response": {
        "webhook": "https://api.squarecloud.app/v2/git/webhook/<webhook-code>"
    }
}

Erros comuns

Código	HTTP	Significado
`INVALID_ACCESS_TOKEN`	400	`access_token` não é `@` e não corresponde ao formato de token do GitHub `ghp_`/`github_pat_`.

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 uma implantação foi enfileirada, 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 a implantação foi armazenada na fila:

Deploy queued: commit 1a2b3c4 of 'main' will be deployed shortly.

Todas as outras respostas terminam com Nothing was deployed.

HTTP	Significado
202	O push é de outra branch que não a do `?branch=` do webhook, por exemplo: `Push received but not queued: it is for 'dev', and this webhook only deploys 'main'. Nothing was deployed.`
400	A URL do webhook ou o payload é inválido, por exemplo um evento `ping` em vez de um `push`.
404	`Unknown webhook: it is not linked to any application (it may have been regenerated). Nothing was deployed.`
413	O payload é maior do que o próprio limite de webhook do GitHub.
415	O webhook não envia `application/json`. Defina o content type como `application/json` nas configurações do webhook no GitHub.
429	Pushes demais em pouco tempo (`KEEP_CALM`).
503	Uma falha temporária do nosso lado impediu que a implantação fosse armazenada.

Se uma entrega mostrar 503, reenvie-a no GitHub em Settings > Webhooks > Recent Deliveries, ou faça push novamente.

Configurar webhook do GitHub

curl --request POST \
  --url https://api.squarecloud.app/v2/apps/{app_id}/deploy/webhook \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "access_token": "<string>"
}
'

import requests

url = "https://api.squarecloud.app/v2/apps/{app_id}/deploy/webhook"

payload = { "access_token": "<string>" }
headers = {
    "Authorization": "<authorization>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
  body: JSON.stringify({access_token: '<string>'})
};

fetch('https://api.squarecloud.app/v2/apps/{app_id}/deploy/webhook', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.squarecloud.app/v2/apps/{app_id}/deploy/webhook",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'access_token' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.squarecloud.app/v2/apps/{app_id}/deploy/webhook"

	payload := strings.NewReader("{\n  \"access_token\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<authorization>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.squarecloud.app/v2/apps/{app_id}/deploy/webhook")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "application/json")
  .body("{\n  \"access_token\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.squarecloud.app/v2/apps/{app_id}/deploy/webhook")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"access_token\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
    "status": "success",
    "response": {
        "webhook": "https://api.squarecloud.app/v2/git/webhook/<webhook-code>"
    }
}

​Parâmetros

​Resposta

​Erros comuns

​Entregas do webhook

Parâmetros

Resposta

Erros comuns

Entregas do webhook