Skip to main content

Enable BigCommerce Webhook

POST 
/api/big-commerce/:integrationInstance/webhooks/enable

Register a single webhook topic with the BigCommerce store so BigCommerce starts calling SKU.io for that event. SKU.io generates (or reuses) a per-instance shared secret that BigCommerce sends back on every delivery.

Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

Authentication: Bearer token (Personal Access Token). Requires the integrations.update permission.

Body:

  • scope (string, required): the topic to enable. One of: store/order/created, store/order/updated, store/product/created, store/product/updated, store/product/deleted, store/shipment/created, store/shipment/updated, store/inventory/order_level/updated, store/inventory/product/updated.

If the topic is already registered the call succeeds without contacting BigCommerce (message "Webhook is already enabled"). An unknown scope, or BigCommerce rejecting the registration, returns 422 with success false.

Request​

Responses​

OK

Response Headers
    Content-Type