Skip to main content
POST
GitHub Webhook の設定
string
必須
アカウントの API キーです。これはアカウント設定で確認できます。
このエンドポイントは、従来型の方法でアプリケーションを GitHub リポジトリに接続します。パーソナルアクセストークン(ghp_* または詳細設定形式の github_pat_*)を生成すると、Square Cloud はそのリポジトリに登録するための一意な webhook URL を返し、push があるたびにデプロイがトリガーされるようになります。代わりに access_token: "@" を送信すると、アプリケーションに設定されている既存の webhook とアクセストークンが削除されます。 webhook を設定または削除すると、現在のデプロイメントの取得 のキャッシュされたレスポンスは無効になります。呼び出しはユーザーごとに 60 秒あたり 5 回までレート制限されており、ワークスペースで共有されているアプリケーションでは呼び出し元に Administrator ロールまたは所有権が必要です。この webhook によってトリガーされたデプロイ試行を確認するには、デプロイメントの一覧 を使用してください。

パラメータ

string
必須
アプリケーションの ID。アプリケーションのダッシュボードの URL で確認できます。
string
必須
GitHub リポジトリのアクセストークン。GitHub Tokens Classic で確認できます。

レスポンス

string
呼び出しが成功したかどうかを示します。成功した場合は success、失敗した場合は error です。
object
レスポンスの内容。

一般的なエラー