GitHub Webhook の設定
POST /v2/apps//deploy/webhook で、個人アクセストークンを使ってアプリケーションを GitHub リポジトリに接続します。@ を送ると webhook を削除します。
POST
GitHub Webhook の設定
apps:deploy スコープを持つ API キーが必要です。
このエンドポイントは、従来型の方法でアプリケーションを GitHub リポジトリに接続します。パーソナルアクセストークン(ghp_* または詳細設定形式の github_pat_*)を生成すると、Square Cloud はそのリポジトリに登録するための一意な webhook URL を返し、push があるたびにデプロイがトリガーされるようになります。代わりに access_token: "@" を送信すると、アプリケーションに設定されている既存の webhook とアクセストークンが削除されます。
webhook を設定または削除すると、現在のデプロイメントの取得 のキャッシュされたレスポンスは無効になります。呼び出しはユーザーごとに 60 秒あたり 5 回までレート制限されており、ワークスペースで共有されているアプリケーションでは呼び出し元に admin のロールまたは所有権が必要です。この webhook によってトリガーされたデプロイ試行を確認するには、デプロイメントの一覧 を使用してください。
webhook と GitHub App の連携 は、同じアプリケーションに同時に設定できます。一方を設定しても、もう一方は削除されません。
パラメータ
string
必須
アプリケーションの ID。アプリケーションのダッシュボードの URL で確認できます。
string
必須
GitHub リポジトリのアクセストークン。GitHub Tokens Classic で確認できます。
レスポンス
string
呼び出しが成功したかどうかを示します。成功した場合は
success、失敗した場合は error です。object
レスポンスの内容。
一般的なエラー
Webhook の配信
GitHub は各 push を webhook URL(POST https://api.squarecloud.app/v2/git/webhook/{webhook})に送信します。応答はデプロイがキューに入ったかどうかを示すプレーンテキスト(text/plain)のため、GitHub の webhook の Recent Deliveries 一覧で各 push がどうなったかを確認できます。JSON で応答するのは 429(KEEP_CALM)のみです。
200 は、デプロイがキューに保存された後にのみ送信されます。
Nothing was deployed. で終わります。
関連項目
- CLI:
squarecloud app deploy webhook - SDK:
api.apps.deploys.setWebhook()(JavaScript),client.apps.deploys.set_webhook()(Python),c.Apps.Deploys.SetWebhook()(Go)

