BigCommerce channel webhook events

67 scopes for sales channels and for events on one channel. Replace {channel_id} with the channel's number when you subscribe, and expect that number in the delivered scope. 52 have sample payloads.

Every event here can also reach agents as an MCP event through Hookdeck: MCP events →

store/channel/created

documented from BigCommerce docs (example)

New sales channel added

Identified by scope field in the body Resource channel

bigcommerce-store-channel-created.json
{
  "store_id": "1000000",
  "producer": "stores/{store_hash}",
  "created_at": 1335335335,
  "scope": "store/channel/created",
  "data": { … },
  "hash": "3f9ea420af83450d7ef9f78b08c8af25b2213637"
}

Key fields

Field Type Example
created_at integer 1335335335

Full schema: 8 fields.

From BigCommerce docs

  • Content type application/json

Send example to Inspect → View as JSON

store/channel/updated

documented official schema

Sales channel name, status or visibility changes

Identified by scope field in the body Resource channel

bigcommerce-store-channel-updated.json
{
  "store_id": "11111",
  "producer": "stores/abcde",
  "created_at": 1335335335,
  "scope": "store/channel/updated",
  "data": { … },
  "hash": "3f9ea420af83450d7ef9f78b08c8af25b2213637"
}

Key fields

Field Type Example
created_at integer 1335335335

Full schema: 8 fields.

From BigCommerce docs

  • Content type application/json

Send example to Inspect → View as JSON

store/channel/metafield/created

documented from BigCommerce docs (example)

Metafield added to a channel

Identified by scope field in the body Resource channel

bigcommerce-store-channel-metafield-created.json
{
  "store_id": "1000000",
  "producer": "stores/{store_hash}",
  "created_at": 1641641646,
  "scope": "store/channel/metafield/created",
  "data": { … },
  "hash": "3f9ea420af83450d7ef9f78b08c8af25b2213637"
}

Key fields

Field Type Example
created_at integer 1641641646

Full schema: 8 fields.

From BigCommerce docs

  • Content type application/json

Send example to Inspect → View as JSON

store/channel/metafield/updated

documented official schema

Channel metafield changes

Identified by scope field in the body Resource channel

bigcommerce-store-channel-metafield-updated.json
{
  "store_id": "11111",
  "producer": "stores/abcde",
  "created_at": 1641641646,
  "scope": "store/channel/metafield/updated",
  "data": { … },
  "hash": "3f9ea420af83450d7ef9f78b08c8af25b2213637"
}

Key fields

Field Type Example
created_at integer 1641641646

Full schema: 9 fields.

From BigCommerce docs

  • Content type application/json

Send example to Inspect → View as JSON

store/channel/metafield/deleted

documented official schema

Metafield removed from a channel

Identified by scope field in the body Resource channel

bigcommerce-store-channel-metafield-deleted.json
{
  "store_id": "11111",
  "producer": "stores/abcde",
  "created_at": 1641641646,
  "scope": "store/channel/metafield/deleted",
  "data": { … },
  "hash": "3f9ea420af83450d7ef9f78b08c8af25b2213637"
}

Key fields

Field Type Example
created_at integer 1641641646

Full schema: 9 fields.

From BigCommerce docs

  • Content type application/json

Send example to Inspect → View as JSON

store/channel/{channel_id}/cart/created

documented from BigCommerce docs (example)

Cart started on this channel

Identified by scope field in the body Resource channel

bigcommerce-store-channel-channel-id-cart-created.json
{
  "store_id": "11111",
  "producer": "stores/abcde",
  "created_at": 1641641646,
  "scope": "store/channel/1/cart/created",
  "data": { … },
  "hash": "3f9ea420af83450d7ef9f78b08c8af25b2213637"
}

Key fields

Field Type Example
created_at integer 1641641646

Full schema: 7 fields.

From BigCommerce docs

  • Content type application/json

Send example to Inspect → View as JSON

store/channel/{channel_id}/cart/updated

documented official schema

Cart changes on this channel

Identified by scope field in the body Resource channel

bigcommerce-store-channel-channel-id-cart-updated.json
{
  "store_id": "11111",
  "producer": "stores/abcde",
  "created_at": 1641641646,
  "scope": "store/channel/1/cart/updated",
  "data": { … },
  "hash": "3f9ea420af83450d7ef9f78b08c8af25b2213637"
}

Key fields

Field Type Example
created_at integer 1641641646

Full schema: 7 fields.

From BigCommerce docs

  • Content type application/json

Send example to Inspect → View as JSON

store/channel/{channel_id}/cart/deleted

documented official schema

Cart removed on this channel

Identified by scope field in the body Resource channel

bigcommerce-store-channel-channel-id-cart-deleted.json
{
  "store_id": "11111",
  "producer": "stores/abcde",
  "created_at": 1641641646,
  "scope": "store/channel/1/cart/deleted",
  "data": { … },
  "hash": "3f9ea420af83450d7ef9f78b08c8af25b2213637"
}

Key fields

Field Type Example
created_at integer 1641641646

Full schema: 7 fields.

From BigCommerce docs

  • Content type application/json

Send example to Inspect → View as JSON

store/channel/{channel_id}/cart/couponApplied

documented official schema

Coupon code added to a cart on this channel

Identified by scope field in the body Resource channel

bigcommerce-store-channel-channel-id-cart-couponapplied.json
{
  "store_id": "11111",
  "producer": "stores/abcde",
  "created_at": 1641641646,
  "scope": "store/channel/1/cart/couponApplied",
  "data": { … },
  "hash": "3f9ea420af83450d7ef9f78b08c8af25b2213637"
}

Key fields

Field Type Example
created_at integer 1641641646

Full schema: 7 fields.

From BigCommerce docs

  • Content type application/json

Send example to Inspect → View as JSON

store/channel/{channel_id}/cart/abandoned

documented official schema

Cart abandoned on this channel

Identified by scope field in the body Resource channel

bigcommerce-store-channel-channel-id-cart-abandoned.json
{
  "store_id": "11111",
  "producer": "stores/abcde",
  "created_at": 1641641646,
  "scope": "store/channel/1/cart/abandoned",
  "data": { … },
  "hash": "3f9ea420af83450d7ef9f78b08c8af25b2213637"
}

Key fields

Field Type Example
created_at integer 1641641646

Full schema: 7 fields.

From BigCommerce docs

  • Content type application/json

Send example to Inspect → View as JSON

store/channel/{channel_id}/cart/converted

documented official schema

Cart becomes an order on this channel

Identified by scope field in the body Resource channel

bigcommerce-store-channel-channel-id-cart-converted.json
{
  "store_id": "11111",
  "producer": "stores/abcde",
  "created_at": 1641641646,
  "scope": "store/channel/1/cart/converted",
  "data": { … },
  "hash": "3f9ea420af83450d7ef9f78b08c8af25b2213637"
}

Key fields

Field Type Example
created_at integer 1641641646

Full schema: 7 fields.

From BigCommerce docs

  • Content type application/json

Send example to Inspect → View as JSON

store/channel/{channel_id}/cart/lineItem/created

documented from BigCommerce docs (example)

Item added to a cart on this channel

Identified by scope field in the body Resource channel

bigcommerce-store-channel-channel-id-cart-lineitem-created.json
{
  "store_id": "11111",
  "producer": "stores/abcde",
  "created_at": 1641641646,
  "scope": "store/channel/1/cart/lineItem/created",
  "data": { … },
  "hash": "3f9ea420af83450d7ef9f78b08c8af25b2213637"
}

Key fields

Field Type Example
created_at integer 1641641646

Full schema: 8 fields.

From BigCommerce docs

  • Content type application/json

Send example to Inspect → View as JSON

store/channel/{channel_id}/cart/lineItem/updated

documented official schema

Item quantity or options change on this channel

Identified by scope field in the body Resource channel

bigcommerce-store-channel-channel-id-cart-lineitem-updated.json
{
  "store_id": "11111",
  "producer": "stores/abcde",
  "created_at": 1641641646,
  "scope": "store/channel/1/cart/lineItem/updated",
  "data": { … },
  "hash": "3f9ea420af83450d7ef9f78b08c8af25b2213637"
}

Key fields

Field Type Example
created_at integer 1641641646

Full schema: 8 fields.

From BigCommerce docs

  • Content type application/json

Send example to Inspect → View as JSON

store/channel/{channel_id}/cart/lineItem/deleted

documented official schema

Item removed from a cart on this channel

Identified by scope field in the body Resource channel

bigcommerce-store-channel-channel-id-cart-lineitem-deleted.json
{
  "store_id": "11111",
  "producer": "stores/abcde",
  "created_at": 1641641646,
  "scope": "store/channel/1/cart/lineItem/deleted",
  "data": { … },
  "hash": "3f9ea420af83450d7ef9f78b08c8af25b2213637"
}

Key fields

Field Type Example
created_at integer 1641641646

Full schema: 8 fields.

From BigCommerce docs

  • Content type application/json

Send example to Inspect → View as JSON

store/channel/{channel_id}/category/created

documented from BigCommerce docs (example)

Category added to this channel's tree

Identified by scope field in the body Resource channel

bigcommerce-store-channel-channel-id-category-created.json
{
  "store_id": "11111",
  "producer": "stores/abcde",
  "created_at": 1641641646,
  "scope": "store/channel/1/category/created",
  "data": { … },
  "hash": "3f9ea420af83450d7ef9f78b08c8af25b2213637"
}

Key fields

Field Type Example
created_at integer 1641641646

Full schema: 8 fields.

From BigCommerce docs

  • Content type application/json

Send example to Inspect → View as JSON

store/channel/{channel_id}/category/updated

documented official schema

Category changes in this channel's tree

Identified by scope field in the body Resource channel

bigcommerce-store-channel-channel-id-category-updated.json
{
  "store_id": "11111",
  "producer": "stores/abcde",
  "created_at": 1641641646,
  "scope": "store/channel/1/category/updated",
  "data": { … },
  "hash": "3f9ea420af83450d7ef9f78b08c8af25b2213637"
}

Key fields

Field Type Example
created_at integer 1641641646

Full schema: 8 fields.

From BigCommerce docs

  • Content type application/json

Send example to Inspect → View as JSON

store/channel/{channel_id}/category/deleted

documented official schema

Category removed from this channel's tree

Identified by scope field in the body Resource channel

bigcommerce-store-channel-channel-id-category-deleted.json
{
  "store_id": "11111",
  "producer": "stores/abcde",
  "created_at": 1641641646,
  "scope": "store/channel/1/category/deleted",
  "data": { … },
  "hash": "3f9ea420af83450d7ef9f78b08c8af25b2213637"
}

Key fields

Field Type Example
created_at integer 1641641646

Full schema: 8 fields.

From BigCommerce docs

  • Content type application/json

Send example to Inspect → View as JSON

store/channel/{channel_id}/categoryTree/updated

documented from BigCommerce docs (example)

This channel's category tree changes

Identified by scope field in the body Resource channel

bigcommerce-store-channel-channel-id-categorytree-updated.json
{
  "store_id": "11111",
  "producer": "stores/abcde",
  "created_at": 1641641646,
  "scope": "store/channel/1/categoryTree/updated",
  "data": { … },
  "hash": "3f9ea420af83450d7ef9f78b08c8af25b2213637"
}

Key fields

Field Type Example
created_at integer 1641641646

Full schema: 7 fields.

From BigCommerce docs

  • Content type application/json

Send example to Inspect → View as JSON

store/channel/{channel_id}/settings/emailStatus/updated

documented from BigCommerce docs (example)

Email status changes on this channel

Identified by scope field in the body Resource channel

bigcommerce-store-channel-channel-id-settings-emailstatus-updated.json
{
  "store_id": "11111",
  "producer": "stores/abcde",
  "created_at": 1641641646,
  "scope": "store/channel/1/settings/emailStatus/updated",
  "data": { … },
  "hash": "3f9ea420af83450d7ef9f78b08c8af25b2213637"
}

Key fields

Field Type Example
created_at integer 1641641646

Full schema: 7 fields.

From BigCommerce docs

  • Content type application/json

Send example to Inspect → View as JSON

store/channel/{channel_id}/settings/emailStatus/deleted

documented official schema

Email status removed on this channel

Identified by scope field in the body Resource channel

bigcommerce-store-channel-channel-id-settings-emailstatus-deleted.json
{
  "store_id": "11111",
  "producer": "stores/abcde",
  "created_at": 1641641646,
  "scope": "store/channel/1/settings/emailStatus/deleted",
  "data": { … },
  "hash": "3f9ea420af83450d7ef9f78b08c8af25b2213637"
}

Key fields

Field Type Example
created_at integer 1641641646

Full schema: 7 fields.

From BigCommerce docs

  • Content type application/json

Send example to Inspect → View as JSON

store/channel/{channel_id}/email/templates/updated

documented official schema

Email template changes on this channel

Identified by scope field in the body Resource channel

bigcommerce-store-channel-channel-id-email-templates-updated.json
{
  "store_id": "11111",
  "producer": "stores/abcde",
  "created_at": 1641641646,
  "scope": "store/channel/1/email/templates/updated",
  "data": { … },
  "hash": "3f9ea420af83450d7ef9f78b08c8af25b2213637"
}

Key fields

Field Type Example
created_at integer 1641641646

Full schema: 7 fields.

From BigCommerce docs

  • Content type application/json

Send example to Inspect → View as JSON

store/channel/{channel_id}/email/templates/deleted

documented official schema

Email template removed on this channel

Identified by scope field in the body Resource channel

bigcommerce-store-channel-channel-id-email-templates-deleted.json
{
  "store_id": "11111",
  "producer": "stores/abcde",
  "created_at": 1641641646,
  "scope": "store/channel/1/email/templates/deleted",
  "data": { … },
  "hash": "3f9ea420af83450d7ef9f78b08c8af25b2213637"
}

Key fields

Field Type Example
created_at integer 1641641646

Full schema: 7 fields.

From BigCommerce docs

  • Content type application/json

Send example to Inspect → View as JSON

store/channel/{channel_id}/notifications/inventory/updated

documented official schema

Inventory notification changes on this channel

Identified by scope field in the body Resource channel

bigcommerce-store-channel-channel-id-notifications-inventory-updated.json
{
  "store_id": "11111",
  "producer": "stores/abcde",
  "created_at": 1641641646,
  "scope": "store/channel/1/notifications/inventory/updated",
  "data": { … },
  "hash": "3f9ea420af83450d7ef9f78b08c8af25b2213637"
}

Key fields

Field Type Example
created_at integer 1641641646

Full schema: 6 fields.

From BigCommerce docs

  • Content type application/json

Send example to Inspect → View as JSON

store/channel/{channel_id}/notifications/order/updated

documented official schema

Order notification settings change on this channel

Identified by scope field in the body Resource channel

bigcommerce-store-channel-channel-id-notifications-order-updated.json
{
  "store_id": "11111",
  "producer": "stores/abcde",
  "created_at": 1641641646,
  "scope": "store/channel/1/notifications/order/updated",
  "data": { … },
  "hash": "3f9ea420af83450d7ef9f78b08c8af25b2213637"
}

Key fields

Field Type Example
created_at integer 1641641646

Full schema: 6 fields.

From BigCommerce docs

  • Content type application/json

Send example to Inspect → View as JSON

store/channel/{channel_id}/order/created

documented official schema

Order placed on this channel

Identified by scope field in the body Resource channel

bigcommerce-store-channel-channel-id-order-created.json
{
  "store_id": "11111",
  "producer": "stores/abcde",
  "created_at": 1641641646,
  "scope": "store/channel/1/order/created",
  "data": { … },
  "hash": "3f9ea420af83450d7ef9f78b08c8af25b2213637"
}

Key fields

Field Type Example
created_at integer 1641641646

Full schema: 7 fields.

From BigCommerce docs

  • Content type application/json

Send example to Inspect → View as JSON

store/channel/{channel_id}/order/updated

documented from BigCommerce docs (example)

Order changes on this channel

Identified by scope field in the body Resource channel

bigcommerce-store-channel-channel-id-order-updated.json
{
  "store_id": "11111",
  "producer": "stores/abcde",
  "created_at": 1641641646,
  "scope": "store/channel/1/order/updated",
  "data": { … },
  "hash": "3f9ea420af83450d7ef9f78b08c8af25b2213637"
}

Key fields

Field Type Example
created_at integer 1641641646

Full schema: 7 fields.

From BigCommerce docs

  • Content type application/json

Send example to Inspect → View as JSON

store/channel/{channel_id}/order/archived

documented official schema

Order archived on this channel

Identified by scope field in the body Resource channel

bigcommerce-store-channel-channel-id-order-archived.json
{
  "store_id": "11111",
  "producer": "stores/abcde",
  "created_at": 1641641646,
  "scope": "store/channel/1/order/archived",
  "data": { … },
  "hash": "3f9ea420af83450d7ef9f78b08c8af25b2213637"
}

Key fields

Field Type Example
created_at integer 1641641646

Full schema: 7 fields.

From BigCommerce docs

  • Content type application/json

Send example to Inspect → View as JSON

store/channel/{channel_id}/order/statusUpdated

documented official schema

Order moves to a different status on this channel

Identified by scope field in the body Resource channel

bigcommerce-store-channel-channel-id-order-statusupdated.json
{
  "store_id": "11111",
  "producer": "stores/abcde",
  "created_at": 1641641646,
  "scope": "store/channel/1/order/statusUpdated",
  "data": { … },
  "hash": "3f9ea420af83450d7ef9f78b08c8af25b2213637"
}

Key fields

Field Type Example
created_at integer 1641641646

Full schema: 7 fields.

From BigCommerce docs

  • Content type application/json

Send example to Inspect → View as JSON

store/channel/{channel_id}/order/message/created

documented official schema

Message added to an order on this channel

Identified by scope field in the body Resource channel

bigcommerce-store-channel-channel-id-order-message-created.json
{
  "store_id": "11111",
  "producer": "stores/abcde",
  "created_at": 1641641646,
  "scope": "store/channel/1/order/message/created",
  "data": { … },
  "hash": "3f9ea420af83450d7ef9f78b08c8af25b2213637"
}

Key fields

Field Type Example
created_at integer 1641641646

Full schema: 7 fields.

From BigCommerce docs

  • Content type application/json

Send example to Inspect → View as JSON

store/channel/{channel_id}/order/refund/created

documented official schema

Full or partial refund on this channel

Identified by scope field in the body Resource channel

bigcommerce-store-channel-channel-id-order-refund-created.json
{
  "store_id": "11111",
  "producer": "stores/abcde",
  "created_at": 1641641646,
  "scope": "store/channel/1/order/refund/created",
  "data": { … },
  "hash": "3f9ea420af83450d7ef9f78b08c8af25b2213637"
}

Key fields

Field Type Example
created_at integer 1641641646

Full schema: 7 fields.

From BigCommerce docs

  • Content type application/json

Send example to Inspect → View as JSON

store/channel/{channel_id}/page/created

documented from BigCommerce docs (example)

Page added to this channel

Identified by scope field in the body Resource channel

bigcommerce-store-channel-channel-id-page-created.json
{
  "store_id": "11111",
  "producer": "stores/abcde",
  "created_at": 1641641646,
  "scope": "store/channel/1/page/created",
  "data": { … },
  "hash": "3f9ea420af83450d7ef9f78b08c8af25b2213637"
}

Key fields

Field Type Example
created_at integer 1641641646

Full schema: 7 fields.

From BigCommerce docs

  • Content type application/json

Send example to Inspect → View as JSON

store/channel/{channel_id}/page/updated

documented official schema

Page changes on this channel

Identified by scope field in the body Resource channel

bigcommerce-store-channel-channel-id-page-updated.json
{
  "store_id": "11111",
  "producer": "stores/abcde",
  "created_at": 1641641646,
  "scope": "store/channel/1/page/updated",
  "data": { … },
  "hash": "3f9ea420af83450d7ef9f78b08c8af25b2213637"
}

Key fields

Field Type Example
created_at integer 1641641646

Full schema: 7 fields.

From BigCommerce docs

  • Content type application/json

Send example to Inspect → View as JSON

store/channel/{channel_id}/product/assigned

documented from BigCommerce docs (example)

Product added to this channel

Identified by scope field in the body Resource channel

bigcommerce-store-channel-channel-id-product-assigned.json
{
  "store_id": "11111",
  "producer": "stores/abcde",
  "created_at": 1641641646,
  "scope": "store/channel/1/product/assigned",
  "data": { … },
  "hash": "3f9ea420af83450d7ef9f78b08c8af25b2213637"
}

Key fields

Field Type Example
created_at integer 1641641646

Full schema: 7 fields.

From BigCommerce docs

  • Content type application/json

Send example to Inspect → View as JSON

store/channel/{channel_id}/product/unassigned

documented official schema

Product removed from this channel

Identified by scope field in the body Resource channel

bigcommerce-store-channel-channel-id-product-unassigned.json
{
  "store_id": "11111",
  "producer": "stores/abcde",
  "created_at": 1641641646,
  "scope": "store/channel/1/product/unassigned",
  "data": { … },
  "hash": "3f9ea420af83450d7ef9f78b08c8af25b2213637"
}

Key fields

Field Type Example
created_at integer 1641641646

Full schema: 7 fields.

From BigCommerce docs

  • Content type application/json

Send example to Inspect → View as JSON

store/channel/{channel_id}/category/product/assigned

documented official schema

Product placed in a category on this channel

Identified by scope field in the body Resource channel

bigcommerce-store-channel-channel-id-category-product-assigned.json
{
  "store_id": "11111",
  "producer": "stores/abcde",
  "created_at": 1641641646,
  "scope": "store/channel/1/category/product/assigned",
  "data": { … },
  "hash": "3f9ea420af83450d7ef9f78b08c8af25b2213637"
}

Key fields

Field Type Example
created_at integer 1641641646

Full schema: 7 fields.

From BigCommerce docs

  • Content type application/json

Send example to Inspect → View as JSON

store/channel/{channel_id}/category/product/unassigned

documented official schema

Product taken out of a category on this channel

Identified by scope field in the body Resource channel

bigcommerce-store-channel-channel-id-category-product-unassigned.json
{
  "store_id": "11111",
  "producer": "stores/abcde",
  "created_at": 1641641646,
  "scope": "store/channel/1/category/product/unassigned",
  "data": { … },
  "hash": "3f9ea420af83450d7ef9f78b08c8af25b2213637"
}

Key fields

Field Type Example
created_at integer 1641641646

Full schema: 7 fields.

From BigCommerce docs

  • Content type application/json

Send example to Inspect → View as JSON

store/channel/{channel_id}/settings/route/updated

documented from BigCommerce docs (example)

Route changes on this channel

Identified by scope field in the body Resource channel

bigcommerce-store-channel-channel-id-settings-route-updated.json
{
  "store_id": "11111",
  "producer": "stores/abcde",
  "created_at": 1641641646,
  "scope": "store/channel/1/settings/route/updated",
  "data": { … },
  "hash": "3f9ea420af83450d7ef9f78b08c8af25b2213637"
}

Key fields

Field Type Example
created_at integer 1641641646

Full schema: 7 fields.

From BigCommerce docs

  • Content type application/json

Send example to Inspect → View as JSON

store/channel/{channel_id}/script/created

documented from BigCommerce docs (example)

Script added to this channel

Identified by scope field in the body Resource channel

bigcommerce-store-channel-channel-id-script-created.json
{
  "store_id": "11111",
  "producer": "stores/abcde",
  "created_at": 1641641646,
  "scope": "store/channel/1/script/created",
  "data": { … },
  "hash": "3f9ea420af83450d7ef9f78b08c8af25b2213637"
}

Key fields

Field Type Example
created_at integer 1641641646

Full schema: 7 fields.

From BigCommerce docs

  • Content type application/json

Send example to Inspect → View as JSON

store/channel/{channel_id}/script/updated

documented official schema

Script changes on this channel

Identified by scope field in the body Resource channel

bigcommerce-store-channel-channel-id-script-updated.json
{
  "store_id": "11111",
  "producer": "stores/abcde",
  "created_at": 1641641646,
  "scope": "store/channel/1/script/updated",
  "data": { … },
  "hash": "3f9ea420af83450d7ef9f78b08c8af25b2213637"
}

Key fields

Field Type Example
created_at integer 1641641646

Full schema: 7 fields.

From BigCommerce docs

  • Content type application/json

Send example to Inspect → View as JSON

store/channel/{channel_id}/settings/currency/updated

documented No payload yet

Currency settings change on this channel

Identified by scope field in the body Resource channel

No payload yet.

Help fill this in → View as JSON

store/channel/{channel_id}/settings/profile/updated

documented No payload yet

Store profile settings change for this channel

Identified by scope field in the body Resource channel

No payload yet.

Help fill this in → View as JSON

store/channel/{channel_id}/settings/locale/added

documented No payload yet

Locale added to a channel

Identified by scope field in the body Resource channel

No payload yet.

Help fill this in → View as JSON

store/channel/{channel_id}/settings/locale/updated

documented No payload yet

Locale changes on a channel

Identified by scope field in the body Resource channel

No payload yet.

Help fill this in → View as JSON

store/channel/{channel_id}/settings/locale/deleted

documented No payload yet

Locale removed from a channel

Identified by scope field in the body Resource channel

No payload yet.

Help fill this in → View as JSON

store/channel/{channel_id}/settings/logo/updated

documented No payload yet

Global logo settings change

Identified by scope field in the body Resource channel

No payload yet.

Help fill this in → View as JSON

store/channel/{channel_id}/settings/logo/image/updated

documented No payload yet

Logo image settings change for this channel

Identified by scope field in the body Resource channel

No payload yet.

Help fill this in → View as JSON

store/channel/{channel_id}/settings/favicon/image/updated

documented No payload yet

Favicon image settings change for this channel

Identified by scope field in the body Resource channel

No payload yet.

Help fill this in → View as JSON

store/channel/{channel_id}/settings/checkout/updated

documented No payload yet

Checkout settings change for this channel

Identified by scope field in the body Resource channel

No payload yet.

Help fill this in → View as JSON

store/channel/{channel_id}/settings/seo/updated

documented official schema

SEO settings change for this channel

Identified by scope field in the body Resource channel

bigcommerce-store-channel-channel-id-settings-seo-updated.json
{
  "store_id": "11111",
  "producer": "stores/abcde",
  "created_at": 1641641646,
  "scope": "store/channel/1/settings/seo/updated",
  "data": { … },
  "hash": "3f9ea420af83450d7ef9f78b08c8af25b2213637"
}

Key fields

Field Type Example
created_at integer 1641641646

Full schema: 6 fields.

From BigCommerce docs

  • Content type application/json

Send example to Inspect → View as JSON

store/channel/{channel_id}/settings/search/updated

documented official schema

Storefront search settings change for this channel

Identified by scope field in the body Resource channel

bigcommerce-store-channel-channel-id-settings-search-updated.json
{
  "store_id": "11111",
  "producer": "stores/abcde",
  "created_at": 1641641646,
  "scope": "store/channel/1/settings/search/updated",
  "data": { … },
  "hash": "3f9ea420af83450d7ef9f78b08c8af25b2213637"
}

Key fields

Field Type Example
created_at integer 1641641646

Full schema: 6 fields.

From BigCommerce docs

  • Content type application/json

Send example to Inspect → View as JSON

store/channel/{channel_id}/settings/inventory/updated

documented official schema

Inventory settings change for this channel

Identified by scope field in the body Resource channel

bigcommerce-store-channel-channel-id-settings-inventory-updated.json
{
  "store_id": "11111",
  "producer": "stores/abcde",
  "created_at": 1641641646,
  "scope": "store/channel/1/settings/inventory/updated",
  "data": { … },
  "hash": "3f9ea420af83450d7ef9f78b08c8af25b2213637"
}

Key fields

Field Type Example
created_at integer 1641641646

Full schema: 6 fields.

From BigCommerce docs

  • Content type application/json

Send example to Inspect → View as JSON

store/channel/{channel_id}/settings/robots/updated

documented No payload yet

Robots settings change for this channel

Identified by scope field in the body Resource channel

No payload yet.

Help fill this in → View as JSON

store/channel/{channel_id}/settings/category/updated

documented No payload yet

Category settings change for this channel

Identified by scope field in the body Resource channel

No payload yet.

Help fill this in → View as JSON

store/channel/{channel_id}/settings/product/updated

documented No payload yet

Product settings change for this channel

Identified by scope field in the body Resource channel

No payload yet.

Help fill this in → View as JSON

store/channel/{channel_id}/settings/catalog/updated

documented No payload yet

Catalog settings change for this channel

Identified by scope field in the body Resource channel

No payload yet.

Help fill this in → View as JSON

store/channel/{channel_id}/settings/security/updated

documented No payload yet

Security settings change for this channel

Identified by scope field in the body Resource channel

No payload yet.

Help fill this in → View as JSON

store/channel/{channel_id}/settings/customer/updated

documented No payload yet

Customer or privacy settings change for this channel

Identified by scope field in the body Resource channel

No payload yet.

Help fill this in → View as JSON

store/channel/{channel_id}/settings/site/updated

documented from BigCommerce docs (example)

Site created, changed or removed on this channel

Identified by scope field in the body Resource channel

bigcommerce-store-channel-channel-id-settings-site-updated.json
{
  "store_id": "11111",
  "producer": "stores/abcde",
  "created_at": 1641641646,
  "scope": "store/channel/1/settings/site/updated",
  "data": { … },
  "hash": "3f9ea420af83450d7ef9f78b08c8af25b2213637"
}

Key fields

Field Type Example
created_at integer 1641641646

Full schema: 7 fields.

From BigCommerce docs

  • Content type application/json

Send example to Inspect → View as JSON

store/channel/{channel_id}/settings/site/checkoutUrl/updated

documented official schema

Checkout domain changes on this channel

Identified by scope field in the body Resource channel

bigcommerce-store-channel-channel-id-settings-site-checkouturl-updated.json
{
  "store_id": "11111",
  "producer": "stores/abcde",
  "created_at": 1641641646,
  "scope": "store/channel/1/settings/site/checkoutUrl/updated",
  "data": { … },
  "hash": "3f9ea420af83450d7ef9f78b08c8af25b2213637"
}

Key fields

Field Type Example
created_at integer 1641641646

Full schema: 7 fields.

From BigCommerce docs

  • Content type application/json

Send example to Inspect → View as JSON

store/channel/{channel_id}/settings/site/checkoutUrl/deleted

documented official schema

Checkout domain removed on this channel

Identified by scope field in the body Resource channel

bigcommerce-store-channel-channel-id-settings-site-checkouturl-deleted.json
{
  "store_id": "11111",
  "producer": "stores/abcde",
  "created_at": 1641641646,
  "scope": "store/channel/1/settings/site/checkoutUrl/deleted",
  "data": { … },
  "hash": "3f9ea420af83450d7ef9f78b08c8af25b2213637"
}

Key fields

Field Type Example
created_at integer 1641641646

Full schema: 7 fields.

From BigCommerce docs

  • Content type application/json

Send example to Inspect → View as JSON

store/channel/{channel_id}/socialMediaLinks/updated

documented from BigCommerce docs (example)

Social media link changes on this channel

Identified by scope field in the body Resource channel

bigcommerce-store-channel-channel-id-socialmedialinks-updated.json
{
  "store_id": "11111",
  "producer": "stores/abcde",
  "created_at": 1641641646,
  "scope": "store/channel/1/socialMediaLinks/updated",
  "data": { … },
  "hash": "3f9ea420af83450d7ef9f78b08c8af25b2213637"
}

Key fields

Field Type Example
created_at integer 1641641646

Full schema: 6 fields.

From BigCommerce docs

  • Content type application/json

Send example to Inspect → View as JSON

store/channel/{channel_id}/theme/configuration/created

documented from BigCommerce docs (example)

Theme added for this channel

Identified by scope field in the body Resource channel

bigcommerce-store-channel-channel-id-theme-configuration-created.json
{
  "store_id": "11111",
  "producer": "stores/abcde",
  "created_at": 1641641646,
  "scope": "store/channel/1/theme/configuration/created",
  "data": { … },
  "hash": "3f9ea420af83450d7ef9f78b08c8af25b2213637"
}

Key fields

Field Type Example
created_at integer 1641641646

Full schema: 10 fields.

From BigCommerce docs

  • Content type application/json

Send example to Inspect → View as JSON

store/channel/{channel_id}/theme/configuration/activated

documented official schema

Theme published for this channel

Identified by scope field in the body Resource channel

bigcommerce-store-channel-channel-id-theme-configuration-activated.json
{
  "store_id": "11111",
  "producer": "stores/abcde",
  "created_at": 1641641646,
  "scope": "store/channel/1/theme/configuration/activated",
  "data": { … },
  "hash": "3f9ea420af83450d7ef9f78b08c8af25b2213637"
}

Key fields

Field Type Example
created_at integer 1641641646

Full schema: 10 fields.

From BigCommerce docs

  • Content type application/json

Send example to Inspect → View as JSON

store/channel/*/inventory/product/stock_changed

documented from BigCommerce docs (example)

Product or variant stock changes at a location

Identified by scope field in the body Resource channel

bigcommerce-store-channel-inventory-product-stock-changed.json
{
  "producer": "stores/{store_hash}",
  "hash": "996ea203c939d05ca667a515ef2f029976d6df80",
  "created_at": 1682624640,
  "store_id": "1000000",
  "scope": "store/channel/*/inventory/product/stock_changed",
  "data": { … }
}

Key fields

Field Type Example
created_at integer 1682624640

Full schema: 9 fields.

From BigCommerce docs

  • Content type application/json

Send example to Inspect → View as JSON

store/channel/*/inventory/product/low_stock_reached

documented official schema

Order takes stock to the low-stock value or below

Identified by scope field in the body Resource channel

bigcommerce-store-channel-inventory-product-low-stock-reached.json
{
  "producer": "stores/{store_hash}",
  "hash": "996ea203c939d05ca667a515ef2f029976d6df80",
  "created_at": 1682624640,
  "store_id": "1234567890",
  "scope": "store/channel/*/inventory/product/low_stock_reached",
  "data": { … }
}

Key fields

Field Type Example
created_at integer 1682624640

Full schema: 9 fields.

From BigCommerce docs

  • Content type application/json

Send example to Inspect → View as JSON

store/channel/*/inventory/product/out_of_stock_reached

documented official schema

Order takes stock at a location to zero

Identified by scope field in the body Resource channel

bigcommerce-store-channel-inventory-product-out-of-stock-reached.json
{
  "producer": "stores/{store_hash}",
  "hash": "996ea203c939d05ca667a515ef2f029976d6df80",
  "created_at": 1682624640,
  "store_id": "1234567890",
  "scope": "store/channel/*/inventory/product/out_of_stock_reached",
  "data": { … }
}

Key fields

Field Type Example
created_at integer 1682624640

Full schema: 9 fields.

From BigCommerce docs

  • Content type application/json

Send example to Inspect → View as JSON

store/channel/*/inventory/product/settings_changed

documented official schema

Safety stock, in-stock flag or warning level changes

Identified by scope field in the body Resource channel

bigcommerce-store-channel-inventory-product-settings-changed.json
{
  "producer": "stores/{store_hash}",
  "hash": "996ea203c939d05ca667a515ef2f029976d6df80",
  "created_at": 1682624640,
  "store_id": "1234567890",
  "scope": "store/channel/*/inventory/product/settings_changed",
  "data": { … }
}

Key fields

Field Type Example
created_at integer 1682624640

Full schema: 9 fields.

From BigCommerce docs

  • Content type application/json

Send example to Inspect → View as JSON

Route BigCommerce events by type.

Event Gateway receives every BigCommerce delivery and filters and routes it by event type, so each service gets only the events it handles.

Not affiliated with BigCommerce. Facts are compiled from public sources and linked inline.