Skip to main content

Disable BigCommerce Webhook

POST 

/api/big-commerce/:integrationInstance/webhooks/disable

Remove a webhook topic's registration from the BigCommerce store and from SKU.io, so BigCommerce stops calling SKU.io for that event.

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 disable. 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 no registration exists for the scope the call succeeds with message "Webhook is already disabled". A registration that BigCommerce no longer has (404) is still removed locally. Any other BigCommerce error returns 422 with success false.

Request​

Responses​

OK

Response Headers
    Content-Type