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.
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
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthorized
Response Headers
Forbidden
Response Headers
Not Found
Response Headers
Unprocessable Entity
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.