A webhooks notifies application when specific events occur on a Big Commerce store. Webhooks can be used to notify external applications when an order is placed, a customer is created, or a product is updated, among other things.
- Listening for events
Webhooks fire when shoppers perform actions on the storefront and when users make changes in the control panel. They will also fire when changes are made using an API.
- Creating a Webhook
To create a webhook, send a POST request to /stores/{{STORE_HASH}}/v3/hooks. Set the scope property value equal to the Name / Scope of the webhook to be created.
The destination URL must be served on port 443; custom ports are not currently supported. Webhooks POST request headers and body.
- Available webhooks
The following resources have webhooks events available to apps:
- Carts
- Cart Line Items
- Categories
- Customers
- Orders
- Products
- Shipments
- SKUs
- Stores
- Subscribers
- Use of ngrok
Ngrok is a helpful tool for viewing webhook callbacks BigCommerce sends to your app. Ngrok creates a publicly accessible tunnel URL to an application running on your machine. When using ngrok you can view HTTP request details in its web interface.