Skip to main content
ドキュメントへの更新が頻繁に発行されており、このページの翻訳はまだ行われている場合があります。 最新の情報については、「英語のドキュメント」を参照してください。
現在、GitHub AE は限定的リリースです。

webhook について

この記事の内容

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

: 現在、GitHub Webhook では IPv6 はサポートされていませんが、今後サポートされる予定です。 /meta REST API エンドポイントは、その遷移を有効にするための IPv6 範囲を返します。

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 イベントを参照してください。