メモ
この記事は、GitHub Marketplace でのアプリの公開にのみ適用されます。 GitHub Marketplace での GitHub Actions の公開について詳しくは、「GitHub Marketplaceでのアクションの公開」をご覧ください。
GitHub Marketplaceのイベントwebhookは、アプリケーションのGitHub Marketplaceリストページからのみセットアップできます。 他のすべてのイベントは、アプリケーションの開発者設定ページから設定できます。 GitHub Marketplace リストを作成していない場合は、「アプリケーションのリストのドラフト」を読んで、その方法を学びましょう。
Webhook の作成
GitHub Marketplace リストの Webhook を作成するには、GitHub Marketplace リスト ページの左サイドバーにある [Webhook] をクリックします。 webhookを設定するのに必要な、以下のwebhookの設定オプションが表示されます。
ペイロード URL
ペイロード URL は、Webhook の POST 要求を受け取るサーバーの URL です。
コンテンツの種類
webhookは、様々なコンテンツタイプを使って配信できます。
application/jsonのコンテンツ タイプは、POST要求の本文として JSON ペイロードを直接配信します。application/x-www-form-urlencodedのコンテンツ タイプは、payloadというフォーム パラメーターとして JSON ペイロードを送信します。
ニーズに最適なプリセットを選択してください。GitHubでは、application/json コンテンツ タイプを使用することをお勧めします。
秘密
Webhook のシークレットを設定することで、ペイロードの URL に送信される POST 要求が、GitHub からのものであることを保証できます。 シークレットを設定すると、Webhook の POST 要求で X-Hub-Signature および X-Hub-Signature-256 ヘッダーを受け取ります。 署名ヘッダーを持つシークレットを使って Webhook ペイロードをセキュアに保つ方法の詳細については、「Webhook 配信を検証する」を参照してください。
アクティブ
デフォルトでは、webhookの配信は「Active」です。 「Active」の選択を解除すれば、開発の間webhookペイロードの配信を無効にできます。 webhookの配信を無効にした場合、レビューのためにアプリケーションをサブミットする前には「Active」を選択しなければなりません。
Webhook配信の確認
GitHub Marketplace Webhook を構成すると、アプリケーションの GitHub Marketplace リスティング内の POST ページから **** リクエストペイロードを検査できるようになります。 GitHubは、配信の失敗を再送信しません。 アプリが、GitHubによって送信されたすべての Webhook ペイロードを受信できることを確認します。
