Notifications and webhooks
What SureBright can tell your systems when something happens, the mechanism for each kind of event today, and what it does not push.
This page answers one question: when something happens in your protection programme, how do your own systems find out? Some events are pushed to you, some you read from an API response, and some you have to poll for.
SureBright does not send contract or claim events to a merchant endpoint today. If you need contract or claim changes pushed to your systems, ask your SureBright contact.
Find the mechanism#
Polling for contract changes#
Get Contracts for Order takes one storeId and one partnerOrderId per call and returns the order with its active contracts. Cancelled contracts are left out, so a contractId you stored that no longer appears in data.contracts has been cancelled.
There is no endpoint that lists every contract changed since a point in time. In practice:
Store the
contractIdvalues from the create response against your order lines.Re-read an order when something happens to it on your side, for example a refund or an edit, rather than on a timer across all orders.
If you do run a periodic check, keep it to recent orders and a modest request rate. See Limits, idempotency and versioning.
The abandoned-cart Webhook#
This is the one place where SureBright posts events to a web address you own. It is set up in the merchant portal under Abandoned Cart, then Messages → Connected tools, on stores where Abandoned Cart is switched on. It carries abandoned-cart events only, not contract or claim events.
Compute the HMAC over the body exactly as received, before any JSON parsing, and compare it with the header. Use the X-SureBright-Delivery value to ignore a delivery you have already processed. The event names and what each one carries are listed on Channels and connected tools; the full field list is in the Event catalog on the Connected tools screen.
Webhooks SureBright receives#
When your store runs on a supported platform, SureBright subscribes to that platform's order, refund, fulfilment and product events so that contracts follow your orders. Those are inbound to SureBright and you never call them. They are listed on Platform webhooks SureBright receives, which is useful when you audit the webhooks on your store.
A custom integration has no such subscription. You tell SureBright about a new, changed or cancelled order yourself, with the calls in Integrate with the API.
Related#
The calls that create, update and look up contracts.
The Webhook, Klaviyo and Omnisend for abandoned-cart events.
Storefront callbacks and DOM events.
What SureBright sends to customers and when.