Magidoc
Webhooks During the API Development Preview
#

Webhooks allow your app to stay up to date with changes or respond to events in Whatnot. During the development preview, we allow access to one event, though more events may be added in the future.

Receiving a Webhook Event

#

Webhooks will be sent from Whatnot via an HTTP POST request with the following body:

    
  

The Webhook will also include Whatnot-specific headers:

    
  

Validating the Webhook

#

To validate the Webhook, you must verify the X-Whatnot-Webhook-Signature header. The signature is calculated using the HMAC SHA256 algorithm with the request body and your app's webhook key. The webhook secret key will be provided to you by a Whatnot representative.

    
  

The POST request must be responded to with HTTP Status 200 OK. When a different code is received, the Webhook Event will attempt to retry up to 5 times over the next approximate 10 minutes.

Creating a Webhook

#

During the preview period, please reach out to [email protected] to subscribe to a webhook. In your request, include your App ID, the URL that will receive POST requests, and the topic to subscribe to.

Webhook Topics

#

Product Sold - product/sold
#

The "Product Sold" webhook object is sent when a product is sold and can be used to remove quantity from a product that has been sold.

    
  
Bulk Operation - bulk_operation/finished
#

The "Bulk Operation" webhook object is sent when a bulk operation has completed, and can be used to know when to check the result of the bulk operation.

Statuses are BulkOperationStatus from the GraphQL Schema.

    
  
Listing Created - listing/created
#
Listing Updated - listing/updated
#

The "Listing Created" and "Listing Updated" webhook object is sent when a listing is created or updated. It includes a subset of fields on the listing, and can be used to determine if a listing is an AUCTION.