GitHub Marketplaceのイベントwebhookは、アプリケーションのGitHub Marketplaceリストページからのみセットアップできます。 他のすべてのイベントは、アプリケーションの開発者設定ページから設定できます。 GitHub Marketplaceのリストを作成していない場合は、「ドラフトのGitHub Marketplaceリストの作成」を読んで、その方法を学んでください。
webhookの作成
GitHub Marketplaceリストのwebhookを作成するには、GitHub Marketplaceリストページの左のサイドバーでWebhookをクリックしてください。 webhookを設定するのに必要な、以下のwebhookの設定オプションが表示されます。
Payload URL
ペイロードURLは、webhookのPOSTリクエストを受信するサーバーのURLです。
Content type
webhookは、様々なコンテンツタイプを使って配信できます。
application/jsonコンテンツタイプは、JSONペイロードをPOSTリクエストのボディとして直接配信します。application/x-www-form-urlencodedコンテンツタイプは、JSONペイロードをpayloadと呼ばれるフォームのパラメータとして送信します。
要求に最適なものを選んでください。 GitHubは、application/jsonコンテンツタイプの利用をおすすめします。
Secret
webhookのシークレットを設定することで、ペイロードのURLに送信されるPOSTリクエストが、GitHub Enterprise Cloudからのものであることが保証できます。 When you set a secret, you'll receive the X-Hub-Signature and X-Hub-Signature-256 headers in the webhook POST request. 署名ヘッダでシークレットを使用してwebhookのペイロードをセキュアに保つ方法に関する詳細については、「webhookをセキュアに保つ」を参照してください。
Active
デフォルトでは、webhookの配信は「Active」です。 「Active」の選択を解除すれば、開発の間webhookペイロードの配信を無効にできます。 webhookの配信を無効にした場合、レビューのためにアプリケーションをサブミットする前には「Active」を選択しなければなりません。
webhookの配信の表示
GitHub Marketplace webhookを設定すると、アプリケーションのGitHub MarketplaceリストのWebhookページから、POSTリクエストのペイロードを調べることができるようになります。 GitHubは、失敗した配信の試行を再送信しません。 GitHubが送信したすべてのwebhookのペイロードを、アプリケーションが確実に受信できるようにしてください。
