Gumroad Ping is a simple alert that notifies you in real time whenever one of your products is purchased.

The ping comes in the form of an HTTP POST request to the URL that you specify in your account settings. You can also use our API and subscribe to be notified of future sales. If your endpoint does not return a 200 HTTP status code, the POST is retried once an hour for up to 3 hours.

If you are using the Overlay/Embed on your website, then the same JSON along with a "post_message_name" key and "sale" value is also sent to the parent iFrame.

For security reasons we highly recommend that you use an HTTPS endpoint as your URL.

You can pass unique URL parameters by adding them to any Gumroad product URL. If passed, they will show up in the url_params dictionary as seen below.

You can use Gumroad Ping to:

  • Thank the purchaser publicly on your website.
  • Generate QR codes.
  • Create an account for them on your own platform.

In each request, Gumroad sends these parameters:

  • sale_id (the id of the sale)
  • sale_timestamp (the timestamp of the sale)
  • order_number (numeric version of sale_id)
  • seller_id
  • product_id
  • product_permalink
  • email (the email of the buyer)
  • url_params {'source_url' : 'https%3A%2F%2Fgumroad.com%2Fwidgets', 'campaignid' : 'c123', 'userid' : '456', 'version' : '1.4.5' }
  • full_name (if present, the name of the buyer)
  • purchaser_id (the id of the purchaser's Gumroad account, if the purchaser has one)
  • subscription_id (the id of the subscription, if the purchase is part of a subscription)
  • ip_country (if present, the country of the buyer's IP address)
  • price (the price paid, in USD cents)
  • recurrence (if present, the recurrence of the payment option chosen by the buyer such as 'monthly', 'yearly', etc)
  • variants (if present, a dictionary {'size' : 'large', 'color' : 'red'})
  • offer_code (if present)
  • test (if you are buying your own product, for testing purposes)
  • custom_fields (if present, a dictionary {'name' : 'john smith', 'spouse name' : 'jane smith'})
  • shipping_information (if present, a dictionary)
  • is_recurring_charge (if relevant, a boolean)
  • is_preorder_authorization (if relevant, a boolean)
  • license_key (if licenses are enabled for the product)
  • quantity
  • shipping_rate (the shipping paid, in USD cents, if the product is a physical product)
  • affiliate (if present, the affiliate's email address)
  • affiliate_credit_amount_cents (if present, the amount paid to the affiliate in USD cents)
  • is_gift_receiver_purchase (true if a gift, false otherwise)
  • gifter_email (email address of gifter)
  • gift_price (the price paid by the gifter, in USD cents)
  • refunded (true if this sale has been refunded, false otherwise)