プランの変更を通知するよう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の設定オプションが表示されます。

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からのものであることが保証できます。 シークレットを設定すると、webhookのPOSTリクエスト中のX-Hub-Signature及びX-Hub-Signature-256ヘッダを受信することになります。 署名ヘッダでシークレットを使用してwebhookのペイロードをセキュアに保つ方法に関する詳細については、「webhookをセキュアに保つ」を参照してください。

Active

デフォルトでは、webhookの配信は「Active」です。 「Active」の選択を解除すれば、開発の間webhookペイロードの配信を無効にできます。 webhookの配信を無効にした場合、レビューのためにアプリケーションをサブミットする前には「Active」を選択しなければなりません。

webhookの配信の表示

GitHub Marketplace webhookを設定すると、アプリケーションのGitHub MarketplaceリストWebhookページから、POSTリクエストのペイロードを調べることができるようになります。 GitHubは、失敗した配信の試行を再送信しません。 GitHubが送信したすべてのwebhookのペイロードを、アプリケーションが確実に受信できるようにしてください。

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

このドキュメントは役立ちましたか?プライバシーポリシー

これらのドキュメントを素晴らしいものにするのを手伝ってください!

GitHubのすべてのドキュメントはオープンソースです。間違っていたり、はっきりしないところがありましたか?Pull Requestをお送りください。

コントリビューションを行う

OR, コントリビューションの方法を学んでください。

問題がまだ解決していませんか?

GitHubコミュニティで質問するサポートへの連絡