Webhook は、GitHub で特定のイベントが発生するたびにトリガーできます。 たとえば以下のような場合にトリガーするように Webhook を構成できます。
- リポジトリへのコードのプッシュ
- プルリクエストのオープン
- GitHub Pagesサイトの構築
- Team への新しいメンバーの追加
Webhook は、 Organization、リポジトリ、または GitHub App に追加できます。
Webhook を追加する場合、サブスクライブするイベントを選択します。 サーバーへの HTTP 要求の数を制限するには、扱う予定の特定のイベントのみをサブスクライブする必要があります。 既定では、Organization またはリポジトリにインストールされている Webhook はプッシュ イベントにのみサブスクライブされます。 既定では、GitHub Apps の Webhook はどのイベントにもサブスクライブされません。 Webhook がサブスクライブされるイベントはいつでも変更できます。 Webhook イベントの完全な一覧については、「Webhook のイベントとペイロード」を参照してください。
通常、Webhooks イベントを受信するにはサーバーが必要です。 Webhook を追加する場合、Webhook イベントを受信する URL を指定します。 Webhook がサブスクライブされているイベントが発生すると、GitHub によって、この URL に HTTP POST ペイロードが送信されます。
サーバーは Webhook イベントを受信すると、Webhook を処理して応答できます。 たとえば、サーバーで実行されているコードでは、Webhook イベントを受信したときに、外部の issue トラッカーの更新、CI ビルドのトリガー、バックアップ ミラーの更新、運用サーバーへのデプロイを行うことができます。
各インストール ターゲット (特定の Organization または特定のリポジトリ) のイベントごとに最大 20 の Webhook を作成できます。
注: 現在、GitHub Webhook では IPv6 はサポートされていませんが、今後サポートされる予定です。 /meta REST API エンドポイントは、その遷移を有効にするための IPv6 範囲を返します。