Configurar Webhook de GitHub

POST

apps

{app_id}

deploy

webhook

Configurar Webhook de 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

requerido

La clave de API de tu cuenta. Puedes encontrarla en la configuración de tu cuenta.

Requiere una clave de API con el scope apps:deploy. Este endpoint conecta una aplicación a un repositorio de GitHub de la manera clásica: genera un token de acceso personal (formato ghp_* o el de grano fino github_pat_*) y Square Cloud devuelve una URL de webhook única para registrar en ese repositorio, de modo que los pushes disparen un despliegue. Si en cambio envías access_token: "@", se elimina el webhook y el token de acceso existentes de la aplicación. Configurar o eliminar un webhook invalida la respuesta en caché de Obtener Despliegue Actual. Las llamadas están limitadas a 5 cada 60 segundos por usuario, y en aplicaciones compartidas en un workspace quien llama necesita el rol admin o ser el propietario. Para revisar los intentos de despliegue disparados por este webhook, usa Listar Despliegues. Un webhook y un vínculo de la GitHub App pueden estar configurados en la misma aplicación al mismo tiempo: configurar uno no elimina el otro.

Parámetros

string

requerido

El ID de la aplicación. Puedes encontrarlo en la URL del panel de tu aplicación.

string

requerido

El token de acceso de tu repositorio de GitHub. Puedes encontrarlo en tus GitHub Tokens Classic

Respuesta

string

Indica si la llamada fue exitosa: success si lo fue, error si no.

object

El contenido de la respuesta.

Mostrar Alternar objeto

string

La URL del webhook.

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

Errores comunes

Código	HTTP	Significado
`INVALID_ACCESS_TOKEN`	400	`access_token` no es `@` y no coincide con el formato de token de GitHub `ghp_`/`github_pat_`.

Entregas del webhook

GitHub envía cada push a la URL del webhook (POST https://api.squarecloud.app/v2/git/webhook/{webhook}). La respuesta es texto plano (text/plain) que indica si se encoló un deploy, de modo que la lista Recent Deliveries del webhook en GitHub muestra qué pasó con cada push. Solo la respuesta 429 es JSON (KEEP_CALM). Un 200 se envía solo después de que el deploy quedó guardado en la cola:

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

Cualquier otra respuesta termina con Nothing was deployed.

HTTP	Significado
202	El push es de una rama distinta de la `?branch=` del webhook, por ejemplo: `Push received but not queued: it is for 'dev', and this webhook only deploys 'main'. Nothing was deployed.`
400	La URL del webhook o el payload no son válidos, por ejemplo un evento `ping` en lugar de un `push`.
404	`Unknown webhook: it is not linked to any application (it may have been regenerated). Nothing was deployed.`
413	El payload supera el límite de webhooks del propio GitHub.
415	El webhook no envía `application/json`. Configura el tipo de contenido como `application/json` en los ajustes del webhook en GitHub.
429	Demasiados pushes en poco tiempo (`KEEP_CALM`).
503	Una falla temporal de nuestro lado impidió guardar el deploy.

Si una entrega muestra 503, vuelve a enviarla en GitHub en Settings > Webhooks > Recent Deliveries, o haz push de nuevo.

Relacionado

CLI: squarecloud app deploy webhook
SDKs: api.apps.deploys.setWebhook() (JavaScript), client.apps.deploys.set_webhook() (Python), c.Apps.Deploys.SetWebhook() (Go)

Configurar Webhook de 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>"
    }
}

Primeros pasos

Cuenta

Aplicaciones

Bases de datos

Workspaces

IA

Configurar Webhook de GitHub

Parámetros

Respuesta

Errores comunes

Entregas del webhook

Relacionado

​Parámetros

​Respuesta

​Errores comunes

​Entregas del webhook

​Relacionado

Parámetros

Respuesta

Errores comunes

Entregas del webhook

Relacionado