Skip to main content

このバージョンの GitHub Enterprise はこの日付をもって終了となります: 2022-09-28. 重大なセキュリティの問題に対してであっても、パッチリリースは作成されません。 パフォーマンスの向上、セキュリティの向上、新機能の向上を図るために、最新バージョンの GitHub Enterprise にアップグレードします。 アップグレードに関するヘルプについては、GitHub Enterprise サポートにお問い合わせください

webhook について

この記事では、次の項目が扱われます。

インテグレーションの構築とセットアップに役立つwebhookの動作の基本を学んでください。

Webhook を使用すると、GitHub.com の特定のイベントをサブスクライブする GitHub AppsOAuth Apps などの統合を構築または設定できます。 それらのイベントのいずれかがトリガーされると、webhookに設定されたURLにHTTP POSTペイロードが送信されます。 webhookは、外部のIssueトラッカーを更新したり、CIビルドをトリガーしたり、バックアップミラーを更新したり、さらにはプロダクションサーバーへのデプロイをしたりするのに利用できます。 想像力が及ぶかぎりのことが可能です。

Webhooks は、 GitHub EnterpriseOrganization、特定のリポジトリ、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 イベントを参照してください。