Skip to main content
POST
GitHub-Webhook einrichten
string
erforderlich
Der API-Schlüssel für dein Konto. Du findest ihn in deinen Kontoeinstellungen.
Erfordert einen API-Schlüssel mit dem Scope apps:deploy. Dieser Endpunkt verbindet eine Anwendung auf klassische Weise mit einem GitHub-Repository: Erzeuge ein Personal Access Token (Format ghp_* oder das fein abgestufte github_pat_*), und Square Cloud gibt eine eindeutige Webhook-URL zurück, die du in diesem Repository registrierst, damit Pushes ein Deployment auslösen. Sendest du stattdessen access_token: "@", werden der bestehende Webhook und das Zugriffstoken von der Anwendung entfernt. Das Einrichten oder Entfernen eines Webhooks invalidiert die zwischengespeicherte Antwort von Aktuelles Deployment abrufen. Aufrufe sind auf 5 pro 60 Sekunden pro Benutzer begrenzt, und bei Workspace-geteilten Anwendungen benötigt der Aufrufer die Rolle admin oder muss Eigentümer sein. Um die durch diesen Webhook ausgelösten Deployment-Versuche einzusehen, nutze Deployments auflisten. Ein Webhook und eine GitHub-App-Verknüpfung können gleichzeitig für dieselbe Anwendung eingerichtet sein: Das Einrichten des einen entfernt das andere nicht.

Parameter

string
erforderlich
Die ID der Anwendung. Du findest diese in der URL des Dashboards deiner Anwendung.
string
erforderlich
Das Zugriffstoken für dein GitHub-Repository. Du findest dieses in deinen GitHub Tokens Classic

Antwort

string
Gibt an, ob der Aufruf erfolgreich war: success, wenn ja, error, wenn nicht.
object
Der Inhalt der Antwort.

Häufige Fehler

Webhook-Zustellungen

GitHub sendet jeden Push an die Webhook-URL (POST https://api.squarecloud.app/v2/git/webhook/{webhook}). Die Antwort ist reiner Text (text/plain) und sagt, ob ein Deployment in die Warteschlange gestellt wurde, sodass die Liste Recent Deliveries des Webhooks auf GitHub zeigt, was mit jedem Push passiert ist. Nur die 429-Antwort ist JSON (KEEP_CALM). Ein 200 wird erst gesendet, nachdem das Deployment in der Warteschlange gespeichert wurde:
Jede andere Antwort endet mit Nothing was deployed.
Zeigt eine Zustellung 503, stelle sie auf GitHub unter Settings > Webhooks > Recent Deliveries erneut zu oder pushe noch einmal.

Siehe auch