BigCommerce Webhook API

This API is used to create and delete different webhooks required for caching in Front-Commerce of the BigCommerce integration

CREATE

The list of required webhooks which needs to be created for cache invalidation

POSTCategory

https://api.bigcommerce.com/stores/{{STORE_HASH}}/v3/hooks

This webhook will trigger whenever something changes in the category scope.

HEADERS

X-Auth-Token

Content-Type

application/json

Bodyraw

{
    "scope": "store/category/*",
    "destination": "{{HOST}}/bigcommerce/webhook",
    "is_active": true,
    "headers": {
        "x-bigcommerce-webhook-secret": "{{WEBHOOK_SECRET}}"
    }
}

Example Request

curl

curl --location -g 'https://api.bigcommerce.com/stores/{{STORE_HASH}}/v3/hooks' \
--header 'X-Auth-Token: {{ACCESS_TOKEN}}' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
    "scope": "store/category/*",
    "destination": "{{HOST}}/bigcommerce/webhook",
    "is_active": true,
    "headers": {
        "x-bigcommerce-webhook-secret": "{{WEBHOOK_SECRET}}"
    }
}'

Example Response

No response body

This request doesn't return any response body

No response headers

This request doesn't return any response headers

POSTProduct

https://api.bigcommerce.com/stores/{{STORE_HASH}}/v3/hooks

This webhook will trigger whenever something changes in the product scope

HEADERS

X-Auth-Token

Content-Type

application/json

Bodyraw

{
    "scope": "store/product/*",
    "destination": "{{HOST}}/bigcommerce/webhook",
    "is_active": true,
    "headers": {
        "x-bigcommerce-webhook-secret": "{{WEBHOOK_SECRET}}"
    }
}

Example Request

curl

curl --location -g 'https://api.bigcommerce.com/stores/{{STORE_HASH}}/v3/hooks' \
--header 'X-Auth-Token: {{ACCESS_TOKEN}}' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
    "scope": "store/product/*",
    "destination": "{{HOST}}/bigcommerce/webhook",
    "is_active": true,
    "headers": {
        "x-bigcommerce-webhook-secret": "{{WEBHOOK_SECRET}}"
    }
}'

Example Response

No response body

This request doesn't return any response body

No response headers

This request doesn't return any response headers

POSTSKU

https://api.bigcommerce.com/stores/{{STORE_HASH}}/v3/hooks

This webhook will trigger whenever something changes in the sku scope, this includes product variants.

HEADERS

X-Auth-Token

Content-Type

application/json

Bodyraw

{
    "scope": "store/sku/*",
    "destination": "{{HOST}}/bigcommerce/webhook",
    "is_active": true,
    "headers": {
        "x-bigcommerce-webhook-secret": "{{WEBHOOK_SECRET}}"
    }
}

Example Request

curl

curl --location -g 'https://api.bigcommerce.com/stores/{{STORE_HASH}}/v3/hooks' \
--header 'X-Auth-Token: {{ACCESS_TOKEN}}' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
    "scope": "store/sku/*",
    "destination": "{{HOST}}/bigcommerce/webhook",
    "is_active": true,
    "headers": {
        "x-bigcommerce-webhook-secret": "{{WEBHOOK_SECRET}}"
    }
}'

Example Response

No response body

This request doesn't return any response body

No response headers

This request doesn't return any response headers