Platform webhooks SureBright receives

The store-platform events SureBright subscribes to on Shopify, BigCommerce, WooCommerce, Magento, Lightspeed and Shift4Shop, the receiver each one is delivered to, how deliveries are authenticated, and what SureBright does with them.

When you connect a store, SureBright registers webhooks on your platform so contracts follow your orders without any work on your side. This page is the reference list: which events are subscribed, where they are delivered, and how SureBright checks that a delivery is genuine. It is useful when you audit the webhooks on your store, allow-list outbound traffic, or read your platform's delivery logs.

All receivers are under https://{HOST_NAME}/partner/api. They are maintained by SureBright; you never call them yourself, and the subscriptions are re-created if they go missing.

Shopify#

SureBright subscribes 19 topics when the app is installed and keeps them in sync on every reinstall or scope change. The three privacy topics are declared on the app itself rather than subscribed per store.

Every delivery must carry a valid X-Shopify-Hmac-Sha256 signature over the raw body, computed with the app's secret; a bad or missing signature is answered 400 and ignored. Handlers answer 200 once a delivery is accepted, including deliberate no-ops, so Shopify does not retry them.

TopicReceiverWhat SureBright does
orders/create/v1/webhook/shopify/createRecords the order; creates one contract per plan unit when the order is paid.
orders/updated/v1/webhook/shopify/orderDelivered trimmed to the fields SureBright reads. Creates contracts when the order becomes paid, updates customer details, cancels on an effectively full refund.
orders/edited/v1/webhook/shopify/editedReconciles plan quantities after an order edit.
orders/cancelled/v1/webhook/shopify/cancelCancels the order's contracts.
refunds/create/v2/webhook/shopify/refundCancels contracts for refunded plan units; raises a case when a covered product was refunded.
fulfillments/create, fulfillments/update/v2/webhook/shopify/fulfillmentMarks plan lines fulfilled; on fulfillment-based stores dates the contracts, and takes the dates back when a fulfillment is cancelled.
draft_orders/create, draft_orders/update/v1/webhook/shopify/draftOrderRecords the draft order event for the over-the-phone sales flow.
checkouts/create, checkouts/update/v1/webhook/shopify/checkout/cart-recoveryCaptures the cart for Abandoned Cart recovery. Discarded for stores without the feature.
products/update/v1/webhook/shopify/productRefreshes SureBright's copy of the product so it can be quoted.
products/create, products/delete/v1/shopify-webhook/product-create, /v1/shopify-webhook/product-delete (SureBright catalog service)Adds or removes the product in SureBright's catalog.
bulk_operations/finish/v1/webhook/shopify/bulkOperations/finishCompletes a catalog sync that was run as a Shopify bulk operation.
markets/create, markets/update, markets/delete/v1/webhook/shopify/marketsSyncs Shopify Markets so plans are priced per market.
app/uninstalled/v1/webhook/shopify/app/uninstallMarks the store uninstalled and stops processing for it.
customers/data_request, customers/redact, shop/redact (app-level)/v1/webhook/shopify/customer/data-request, /v1/webhook/shopify/customer/redact, /v1/webhook/shopify/shop/redactRecords the privacy request for compliance handling.

BigCommerce#

Registered against your store during the first authorization of the SureBright app. Each subscription carries an x-surebright-api-key header that SureBright generates for your store at install time (a signed platform:store token). A delivery whose key is missing, fails the signature check or names another platform is rejected.

ScopeReceiverWhat SureBright does
store/order/created, store/order/updated/v1/webhook/bigCommerce/orderCreates contracts for paid plan lines; cancels contracts for plan lines removed or cancelled.
store/order/refund/created/v1/webhook/bigCommerce/orderCancels contracts for refunded plan units.
store/shipment/*/v1/webhook/bigCommerce/order/shipmentDates coverage on fulfillment-based stores and creates shipping-protection contracts for the shipment.
store/product/created, store/product/updated/v1/webhook/bigCommerce/productRefreshes the product, its categories and images.
store/category/created, store/category/updated/v1/webhook/bigCommerce/categoryRefreshes the category list used for mapping.

A fifth receiver, /v1/webhook/bigCommerce/order/refund, exists for refund events delivered separately; current installs route refunds to /order. See BigCommerce for the install flow.

WooCommerce#

Four order webhooks are registered on your store when the SureBright plugin is connected. Each delivery is checked against x-wc-webhook-signature, the HMAC WooCommerce computes over the raw body with the webhook's secret, and the store is identified from x-wc-webhook-source. A failed signature is answered 400.

TopicReceiverWhat SureBright does
order.created/v1/webhook/woocommerce/order/createRecords the order and creates contracts for paid plan lines.
order.updated/v1/webhook/woocommerce/order/updateRe-reconciles the order: creates contracts once it is paid and cancels units for refunded or removed plan lines.
order.deleted/v1/webhook/woocommerce/order/deleteCancels the order's contracts.
order.restored/v1/webhook/woocommerce/order/restoreTreated as an update: re-reconciles the restored order.

Magento#

The SureBright Magento module sends events itself rather than through native Magento webhooks: it observes product saves and order saves and posts to SureBright. Each event carries a store-bound access token (sb-access-token header, or sbAccessToken in the body) issued when the module is connected; the token is verified and must name a Magento store.

Module eventReceiverWhat SureBright does
product_create_update/v1/webhook/magento/productRefreshes the product so it can be quoted.
order_create_update/v1/webhook/magento/orderFetches the order from your Magento REST API and creates, updates or cancels contracts to match. The body only needs the order ID and token.
Either, as a typed envelope/v1/webhook/magento/events, /v1/webhook/magento/svixDispatches on sbEventType to the product or order handler above; the svix path is for stores whose module delivers through the Svix relay.

See the Magento install guide.

Lightspeed#

SeriesEventReceiverWhat SureBright does
X-Seriesproduct.update/v1/webhook/lightspeed/productRefreshes the product.
X-Seriessale.update/v1/webhook/lightspeed/orderCreates contracts for completed sales with plan lines; a return cancels the matching contracts.
R-Seriesorder sync/v1/webhook/lightspeedrseries/orderFed by SureBright's own R-Series order sync, not by a Lightspeed webhook. Creates or cancels contracts for the synced sale.

X-Series deliveries are accepted when the body carries Lightspeed's type, domain_prefix and payload; the store is resolved from domain_prefix and must be a connected store.

Shift4Shop#

EventReceiverWhat SureBright does
Order created, order changed/v1/webhook/shift4shop/orderReads the order and creates or cancels contracts for its plan lines.

The store is identified from the store URL in the order payload.

Delivery and retries#

  • A receiver answers 200 when it has accepted a delivery, even when it decides to do nothing (store uninstalled, feature off, nothing relevant changed). Platforms retry only on non-2xx responses, so a 400 from a failed signature is not retried while a 500 from a transient failure is.

  • Processing is idempotent: the same event delivered twice does not create a second contract.

  • Deliveries that cannot be parsed or fail validation are recorded with the platform and store so SureBright can investigate; you do not need to resend them.