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.

プランの変更を通知するようwebhookを設定する

ドラフトの GitHub Marketplace リストを作成した後、顧客アカウント プランの変更が発生したときに通知する Webhook を構成できます。 Webhook を構成したら、アプリで marketplace_purchase イベントの種類を処理できます。

GitHub Marketplaceのイベントwebhookは、アプリケーションのGitHub Marketplaceリストページからのみセットアップできます。 他のすべてのイベントは、アプリケーションの開発者設定ページから設定できます。 まだ 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のペイロードを、アプリケーションが確実に受信できるようにしてください。

最近のGitHub Marketplace webhookの配信の調査