Skip to main content

About webhooks

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

Webhooks allow you to build or set up integrations, such as GitHub Apps or OAuth App, which subscribe to certain events on 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 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 20 webhooks for each event on each installation target (specific organization or specific repository).


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.