Want to track the price of a product, or know when it’s back in stock? We provide webhooks that let you do just that.
1
Register an endpoint
Add an endpoint in the dashboard and copy its signing secret. Each endpoint receives events from every subscription on the account, for the event types you enable on it. Add another when you want a separate URL, such as QA alongside production.
selection is one { "name", "label" } per option in variants.options on the product response; variants.selected can be passed as is. A subscription watches one variant, so every option needs a value. If you leave one out, the request fails with 422 naming it, for example `selection` must also pin: Size: ['S', 'M', 'L']. A product without options takes no selection.Some values, usually colors, are a separate product with their own product_id in variants.options. Selecting one subscribes you to that product, so the product_id in the response and in events can differ from the one you sent. The response’s selection also carries the values that identify the product itself, such as its color, even when you only sent the size.Sending the same scope again (the same events, domains, and selection) returns the existing subscription.domains limits events to those merchants. Pass up to 25 bare domains.
Every subscription reads the product in English, US, USD.Create, list, get, and cancel from the API. Cancelling stops events for that subscription as soon as the call returns.
3
What arrives
Every body has id, timestamp, type, and data. data.subscription_id is your subscription. data.subject names the offer: product_id, merchant domain, locale, and selection (the variant you watch; null for a product without options). The id stays the same when a delivery is retried, so skip any you have already handled.