8f964ea2cb
Co-authored-by: Matt Pollard <mattpollard@users.noreply.github.com> Co-authored-by: Grace Park <gracepark@github.com> Co-authored-by: Steve Guntrip <12534592+stevecat@users.noreply.github.com> Co-authored-by: Robert Sese <sese@github.com> Co-authored-by: Peter Bengtsson <peterbe@github.com> Co-authored-by: Rachael Sewell <rachmari@github.com>
3.2 KiB
title, intro, redirect_from, versions, topics, shortTitle
| title | intro | redirect_from | versions | topics | shortTitle | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Configuring a webhook to notify you of plan changes | After [creating a draft {% data variables.product.prodname_marketplace %} listing](/marketplace/listing-on-github-marketplace/creating-a-draft-github-marketplace-listing/), you can configure a webhook that notifies you when changes to customer account plans occur. After you configure the webhook, you can [handle the `marketplace_purchase` event types](/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events/) in your app. |
|
|
|
Webhooks for plan changes |
The {% data variables.product.prodname_marketplace %} event webhook can only be set up from your application's {% data variables.product.prodname_marketplace %} listing page. You can configure all other events from your application's developer settings page. If you haven't created a {% data variables.product.prodname_marketplace %} listing, read "Creating a draft {% data variables.product.prodname_marketplace %} listing" to learn how.
Creating a webhook
To create a webhook for your {% data variables.product.prodname_marketplace %} listing, click Webhook in the left sidebar of your {% data variables.product.prodname_marketplace %} listing page. You'll see the following webhook configuration options needed to configure your webhook:
Payload URL
{% data reusables.webhooks.payload_url %}
Content type
{% data reusables.webhooks.content_type %} GitHub recommends using the application/json content type.
Secret
{% data reusables.webhooks.secret %}
Active
By default, webhook deliveries are "Active." You can choose to disable the delivery of webhook payloads during development by deselecting "Active." If you've disabled webhook deliveries, you will need to select "Active" before you submit your app for review.
Viewing webhook deliveries
Once you've configured your {% data variables.product.prodname_marketplace %} webhook, you'll be able to inspect POST request payloads from the Webhook page of your application's {% data variables.product.prodname_marketplace %} listing. GitHub doesn't resend failed delivery attempts. Ensure your app can receive all webhook payloads sent by GitHub.
