Skip to main content
We publish frequent updates to our documentation, and translation of this page may still be in progress. For the most current information, please visit the English documentation.

About webhooks

In this article

Learn the basics of how webhooks work to help you build and set up integrations.

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

Webhooks allow you to build or set up integrations, such as GitHub Apps or OAuth Apps, which subscribe to certain events on GitHub.com. When one of those events is triggered, we'll send a HTTP POST payload to the webhook's configured URL. Webhooks can be used to update an external issue tracker, trigger CI builds, update a backup mirror, or even deploy to your production server. You're only limited by your imagination.

Webhooks can be installed on GitHub Enterprise, an organization, a specific repository, or a GitHub App. Once installed, the webhook will be sent each time one or more subscribed events occurs.

You can create up to 250 webhooks for each event on each installation target (GitHub Enterprise Server instance, specific organization, or specific repository).

Events

webhookを設定する際には、ペイロードを送信するイベントを選択するためにUIもしくはAPIが使用できます。 処理する計画の特定のイベントだけをサブスクライブすることによってのみ、サーバーへのHTTPリクエスト数を制限できます。 現在、そして未来のすべてのイベントをサブスクライブすることもできます。 デフォルトでは、webhookはプッシュイベントだけをサブスクライブします。 サブスクライブするイベントのリストは、いつでも変更できます。

Each event corresponds to a certain set of actions that can happen to your organization and/or repository. For example, if you subscribe to the issues event you'll receive detailed payloads every time an issue is opened, closed, labeled, etc.

For a complete list of available webhook events and their payloads, see "Webhook events and payloads."

Ping event

新しい Webhook が作成されると、シンプルな ping イベントが送信され、Webhook が正しくセットアップされたことが通知されます。 このイベントは格納されないため、Events API エンドポイントを介して取得することはできません。

For more information about the ping event webhook payload, see the ping event.