> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.bigcommerce.com/developer/api-reference/rest/integrations/webhooks/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.bigcommerce.com/_mcp/server.

# Webhooks v3

Get notified when specific events occur on a BigCommerce store. For more information, see the [Webhooks Overview](/developer/docs/integrations/webhooks), [Webhooks Events](/developer/docs/integrations/webhooks/event-reference), or [Webhooks Tutorial](/developer/docs/integrations/webhooks/tutorial).

In general, webhook usage follows the workflow:

1. Create a webhook for a specific scope using [Create a Webhook](/developer/api-reference/rest/integrations/webhooks/create-webhooks)
2. Receive event callback payload at the destination URL
3. Respond to callback with success status `2xx` or any failure status
   1. On failure, await second callback attempt
   2. On success, move to event handling
4. Handle event based on payload

Callback payloads have a uniform structure, including the minimum information to uniquely identify what event occurred, on what store, with respect to what data, and at what time. The `data` object serves as the only variable data structure in the payload.

For inventory and location events, `data` will include `location_id`, and `variant_id` or `product_id` as necessary. For all other events `data` will include `type`, `id`, and any scope-specific information (such as `couponId` for the `store/cart/couponApplied`). Scope-specific fields are outlined in the [Webhooks Events](/developer/docs/integrations/webhooks/event-reference).

An example of payload structure is included below. Datatypes are outlined in the following table.

| Field        | Type      | Example                                    |
| ------------ | --------- | ------------------------------------------ |
| `producer`   | `string`  | `stores/abc123`                            |
| `hash`       | `string`  | `dd70c0976e06b67aaf671e73f49dcb79230ebf9d` |
| `created_at` | `integer` | `1561479335`                               |
| `store_id`   | `string`  | `1025646`                                  |
| `scope`      | `string`  | `store/order/created`                      |
| `data`       | `object`  | variable                                   |
| `data.type`  | `string`  | `product`                                  |
| `data.id`    | `integer` | `223`                                      |

**`Example callback structure`**

```json title="Example callback structure"
{
  "producer": "stores/<STORE_HASH>",
  "hash": "<EVENT_HASH>",
  "created_at": "<EVENT_TIMESTAMP>",
  "store_id": "<STORE_ID>",
  "scope": "<WEBHOOK_SCOPE>",
  "data": {
    "<EVENT_DATA>"
  }
}
```

> Build amazing commerce solutions powered by the BigCommerce platform


## API Docs

- Integrations: Webhooks [List Webhooks](https://docs.bigcommerce.com/developer/api-reference/rest/integrations/webhooks/get-webhooks.md)
- Integrations: Webhooks [Create Webhook](https://docs.bigcommerce.com/developer/api-reference/rest/integrations/webhooks/create-webhooks.md)
- Integrations: Webhooks [Get Webhook](https://docs.bigcommerce.com/developer/api-reference/rest/integrations/webhooks/get-webhook.md)
- Integrations: Webhooks [Update Webhook](https://docs.bigcommerce.com/developer/api-reference/rest/integrations/webhooks/update-webhook.md)
- Integrations: Webhooks [Delete Webhook](https://docs.bigcommerce.com/developer/api-reference/rest/integrations/webhooks/delete-webhook.md)
- Integrations: Webhooks [Get Admin Info](https://docs.bigcommerce.com/developer/api-reference/rest/integrations/webhooks/get-hooks-admin.md)
- Integrations: Webhooks [Upsert Email Notifications](https://docs.bigcommerce.com/developer/api-reference/rest/integrations/webhooks/update-hooks-admin.md)

## OpenAPI Specification

The raw OpenAPI 3.1 specification for this API is available at:
- [OpenAPI JSON](https://docs.bigcommerce.com/developer/api-reference/rest/integrations/webhooks/openapi.json)
- [OpenAPI YAML](https://docs.bigcommerce.com/developer/api-reference/rest/integrations/webhooks/openapi.yaml)