Imposta Webhook GitHub

POST

apps

{app_id}

deploy

webhook

Imposta Webhook 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

obbligatorio

La chiave API del tuo account. Puoi trovarla nelle impostazioni del tuo account.

Richiede una chiave API con lo scope apps:deploy. Questo endpoint collega un’applicazione a un repository GitHub nel modo classico: genera un token di accesso personale (formato ghp_* o il formato fine-grained github_pat_*) e Square Cloud restituisce un URL di webhook univoco da registrare su quel repository, così i push attivano un deploy. Inviando access_token: "@" invece rimuove il webhook e il token di accesso esistenti dall’applicazione. Configurare o rimuovere un webhook invalida la risposta memorizzata in cache di Ottieni Deployment Corrente. Le chiamate sono limitate a 5 ogni 60 secondi per utente, e sulle applicazioni condivise in un workspace chi effettua la richiesta deve avere il ruolo admin o essere il proprietario. Per rivedere i tentativi di deploy attivati da questo webhook, usa Elenca Deployment. Un webhook e un collegamento GitHub App possono essere configurati sulla stessa applicazione contemporaneamente: configurarne uno non rimuove l’altro.

Parametri

string

obbligatorio

L’ID dell’applicazione. Puoi trovarlo nell’URL della dashboard della tua applicazione.

string

obbligatorio

Il token di accesso per il tuo repository GitHub. Puoi trovarlo nei tuoi GitHub Tokens Classic

Risposta

string

Indica se la chiamata è andata a buon fine: success in caso affermativo, error in caso contrario.

object

Il contenuto della risposta.

Mostra Mostra oggetto

string

L’URL del webhook.

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

Errori comuni

Codice	HTTP	Significato
`INVALID_ACCESS_TOKEN`	400	`access_token` non è `@` e non corrisponde al formato token GitHub `ghp_`/`github_pat_`.

Consegne del webhook

GitHub invia ogni push all’URL del webhook (POST https://api.squarecloud.app/v2/git/webhook/{webhook}). La risposta è testo semplice (text/plain) che indica se un deploy è stato messo in coda, così l’elenco Recent Deliveries del webhook su GitHub mostra cosa è successo a ogni push. Solo la risposta 429 è in JSON (KEEP_CALM). Un 200 viene inviato solo dopo che il deploy è stato salvato nella coda:

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

Ogni altra risposta termina con Nothing was deployed.

HTTP	Significato
202	Il push riguarda un branch diverso da quello indicato in `?branch=` del webhook, ad esempio: `Push received but not queued: it is for 'dev', and this webhook only deploys 'main'. Nothing was deployed.`
400	L’URL del webhook o il payload non è valido, ad esempio un evento `ping` invece di un `push`.
404	`Unknown webhook: it is not linked to any application (it may have been regenerated). Nothing was deployed.`
413	Il payload supera il limite dei webhook di GitHub stesso.
415	Il webhook non invia `application/json`. Imposta il content type su `application/json` nelle impostazioni del webhook su GitHub.
429	Troppi push in poco tempo (`KEEP_CALM`).
503	Un errore temporaneo da parte nostra ha impedito di salvare il deploy.

Se una consegna mostra 503, riconsegnala su GitHub in Settings > Webhooks > Recent Deliveries, oppure esegui di nuovo il push.

Vedi anche

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

Imposta Webhook 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>"
    }
}

Primi passi

Account

Applicazioni

Database

Workspace

IA

Parametri

Risposta

Errori comuni

Consegne del webhook

Vedi anche

​Parametri

​Risposta

​Errori comuni

​Consegne del webhook

​Vedi anche

Parametri

Risposta

Errori comuni

Consegne del webhook

Vedi anche