Manage Webhooks (Bulk)
Create a Webhook
POST https://api.bigcommerce.com/stores/{store_hash}/v3/hooksRequest
Creates a webhook. Only one webhook at a time can be created. Custom headers can be added. Destination URL must be served on port 443 (custom ports are not currently supported).
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
Body
scopestring
requiredEvent you subscribe to.
Example: store/order/*destinationstring
requiredURL must be active, return a 200 response, and be served on port 443. Custom ports arenʼt currently supported.
Example: https://665b65a6.ngrok.io/webhooksis_activeboolean
Boolean value that indicates whether the webhook is active or not. A webhook subscription becomes deactivated after 90 days of inactivity.
Example: trueevents_history_enabledboolean
deprecatedDeprecated. Boolean value that identifies whether events are stored that could not be received.
Example: trueheadersobject or null
Headers used to validate that webhooks are active. You can pass in any number of custom headers to validate webhooks are being returned.
example
Response
Body
data
application/json
Get Webhooks
GET https://api.bigcommerce.com/stores/{store_hash}/v3/hooksRequest
Returns a list of all webhooks on a store associated to the client_id
used to authenticate the request.
Note: BigCommerce determines the client_id
from the access_token
.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
example
Response
Body
dataarray[object]