Configurer un webhook GitHub

POST

apps

{app_id}

deploy

webhook

Configurer un 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

requis

La clé d’API de votre compte. Vous pouvez la trouver dans les paramètres de votre compte.

Nécessite une clé API avec le scope apps:deploy. Cet endpoint connecte une application à un dépôt GitHub à l’ancienne : générez un jeton d’accès personnel (format ghp_* ou le format fine-grained github_pat_*) et Square Cloud renvoie une URL de webhook unique à enregistrer sur ce dépôt afin que les push déclenchent un déploiement. Envoyer access_token: "@" supprime au contraire le webhook et le jeton d’accès existants de l’application. Configurer ou supprimer un webhook invalide la réponse mise en cache par Obtenir le déploiement actuel. Les appels sont limités à 5 requêtes toutes les 60 secondes par utilisateur, et sur les applications partagées en workspace, l’appelant doit avoir le rôle admin ou en être propriétaire. Pour consulter les tentatives de déploiement déclenchées par ce webhook, utilisez Lister les déploiements. Un webhook et un lien GitHub App peuvent être configurés en même temps sur la même application : configurer l’un ne supprime pas l’autre.

Paramètres

string

requis

L’ID de l’application. Vous pouvez le trouver dans l’URL du tableau de bord de votre application.

string

requis

Le jeton d’accès de votre dépôt GitHub. Vous pouvez le trouver dans vos GitHub Tokens Classic

Réponse

string

Indique si l’appel a réussi : success si c’est le cas, error sinon.

object

Le contenu de la réponse.

Afficher Afficher l'objet

string

L’URL du webhook.

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

Erreurs courantes

Code	HTTP	Signification
`INVALID_ACCESS_TOKEN`	400	`access_token` n’est pas `@` et ne correspond pas au format de jeton GitHub `ghp_`/`github_pat_`.

Livraisons du webhook

GitHub envoie chaque push à l’URL du webhook (POST https://api.squarecloud.app/v2/git/webhook/{webhook}). La réponse est du texte brut (text/plain) qui indique si un déploiement a été mis en file d’attente, de sorte que la liste Recent Deliveries du webhook sur GitHub montre ce qu’il est advenu de chaque push. Seule la réponse 429 est en JSON (KEEP_CALM). Un 200 n’est envoyé qu’une fois le déploiement enregistré dans la file d’attente :

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

Toutes les autres réponses se terminent par Nothing was deployed.

HTTP	Signification
202	Le push concerne une autre branche que le `?branch=` du webhook, par exemple : `Push received but not queued: it is for 'dev', and this webhook only deploys 'main'. Nothing was deployed.`
400	L’URL du webhook ou le payload est invalide, par exemple un événement `ping` au lieu d’un `push`.
404	`Unknown webhook: it is not linked to any application (it may have been regenerated). Nothing was deployed.`
413	Le payload dépasse la limite de webhook de GitHub elle-même.
415	Le webhook n’envoie pas `application/json`. Définissez le content type sur `application/json` dans les paramètres du webhook sur GitHub.
429	Trop de push en peu de temps (`KEEP_CALM`).
503	Une défaillance temporaire de notre côté a empêché l’enregistrement du déploiement.

Si une livraison affiche 503, relancez-la sur GitHub dans Settings > Webhooks > Recent Deliveries, ou refaites un push.

Voir aussi

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

Configurer un 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>"
    }
}

Premiers pas

Compte

Applications

Bases de données

Workspaces

IA

Configurer un webhook GitHub

Paramètres

Réponse

Erreurs courantes

Livraisons du webhook

Voir aussi

​Paramètres

​Réponse

​Erreurs courantes

​Livraisons du webhook

​Voir aussi

Paramètres

Réponse

Erreurs courantes

Livraisons du webhook

Voir aussi