Configurer un webhook GitHub
Connectez une application à un dépôt GitHub avec un jeton d’accès personnel via POST /v2/apps//deploy/webhook, ou envoyez @ pour retirer le webhook.
POST
Configurer un webhook GitHub
string
requis
La clé d’API de votre compte. Vous pouvez la trouver dans les paramètres de votre compte.
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.
Erreurs courantes
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 :
Nothing was deployed.
Chaque réponse
202 est envoyée avant la limite de débit : elle ne consomme donc pas la limite de 1 push toutes les 15 secondes du webhook. Une release envoyée avec git push --follow-tags, ou une pull request fusionnée dont GitHub supprime automatiquement la branche, ne bloque plus le déploiement du push de branche qui arrive en même temps. Pour un tag ou une branche supprimée, la réponse commence par son code, tel qu’il apparaît sur GitHub dans Settings > Webhooks > Recent Deliveries, onglet Response :
Voir aussi
- CLI :
squarecloud app deploy webhook - SDK :
api.apps.deploys.setWebhook()(JavaScript),client.apps.deploys.set_webhook()(Python),c.Apps.Deploys.SetWebhook()(Go)

