Note
この記事は、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 です。
Content type
webhookは、様々なコンテンツタイプを使って配信できます。
application/jsonのコンテンツ タイプは、POST要求の本文として JSON ペイロードを直接配信します。application/x-www-form-urlencodedのコンテンツ タイプは、payloadというフォーム パラメーターとして JSON ペイロードを送信します。
ニーズに最適なプリセットを選択してください。 GitHub は、application/json コンテンツ タイプの使用をお勧めします。
Secret
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 リストの [Webhook] ページから POST 要求ペイロードを検査できるようになります。 GitHubは、失敗した配信の試行を再送信しません。 GitHubが送信したすべてのwebhookのペイロードを、アプリケーションが確実に受信できるようにしてください。
