Webhook を使用すると、GitHub.com の特定のイベントをサブスクライブする GitHub Apps や OAuth Apps などの統合を構築または設定できます。 それらのイベントのいずれかがトリガーされると、webhookに設定されたURLにHTTP POSTペイロードが送信されます。 webhookは、外部のIssueトラッカーを更新したり、CIビルドをトリガーしたり、バックアップミラーを更新したり、さらにはプロダクションサーバーへのデプロイをしたりするのに利用できます。 想像力が及ぶかぎりのことが可能です。
Webhooks は、 GitHub Enterprise、Organization、特定のリポジトリ、GitHub App のいずれかにインストールできます。 インストールされると、1つ以上のサブスクライブされたイベントが発生するたびに、webhookが送信されます。
各インストール ターゲット (GitHub Enterprise Server インスタンス、特定の組織、または特定のリポジトリ) のイベントごとに最大 250 の Webhook を作成できます。
イベント
webhookを設定する際には、ペイロードを送信するイベントを選択するためにUIもしくはAPIが使用できます。 処理する計画の特定のイベント� けをサブスクライブすることによってのみ、サーバーへのHTTPリクエスト数を制限できます。 現在、そして未来のすべてのイベントをサブスクライブすることもできます。 デフォルトでは、webhookはプッシュイベント� けをサブスクライブします。 サブスクライブするイベントのリストは、いつでも変更できます。
それぞれのイベントは、Organizationやリポジトリに生じうる一連のアクションに対応します。 たとえば、issues イベントをサブスクライブしている� �合、Issue のオープン、クローズ、ラベル付けなどが生じるたびに詳細なペイロードを受け取ります。
使用可能な Webhook イベントとそのペイロードの完全な一覧については、「Webhook イベントとペイロード」を参照してく� さい。
Pingイベント
新しい Webhook が作成されると、シンプルな ping イベントが送信され、Webhook が正しくセットアップされたことが通知されます。 このイベントは� �納されないため、Events API エンドポイントを介して取得することはできません。
ping イベントの Webhook ペイロードの詳細については、ping イベントを参照してく� さい。