Skip to main content
POST
GitHub-Webhook einrichten
string
erforderlich
Der API-Schlüssel für Ihr Konto. Sie finden ihn in Ihren Kontoeinstellungen.
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 Administrator oder muss Eigentümer sein. Um die durch diesen Webhook ausgelösten Deployment-Versuche einzusehen, nutze Deployments auflisten.

Parameter

string
erforderlich
Die ID der Anwendung. Sie finden diese in der URL des Dashboards Ihrer Anwendung.
string
erforderlich
Das Zugriffstoken für Ihr GitHub-Repository. Sie finden dieses in Ihren GitHub Tokens Classic

Antwort

string
Gibt an, ob der Aufruf erfolgreich war. success bei Erfolg, error andernfalls.
object
Der Inhalt der Antwort.

Häufige Fehler