Channel Webhooks
Developers building third-party sales channels or multi-storefront capabilities might need notification when a channel in BigCommerce changes so that they can perform downstream actions required to set up or deactivate the channel. To facilitate this, we’ve added store/channel webhook events that fire when you create or update a channel. This article assumes that you’re familiar with webhooks. It introduces channel-related events and is a reference for all BigCommerce channel webhook events and their callback payloads. For an introduction to webhooks on BigCommerce, see Webhooks Overview. For a more general introduction to webhooks, see Webhooks Overview.
To learn more about sales channels, see the Channels Overview. To learn more about how sales channels function in the context of multi-storefront or multi-channel sales, see the channels section of the Multi-Storefront Overview.
Creating a webhook
To create a webhook, send a request to the Create a webhook endpoint. Follow the process described in the Webhooks Overview, and include a channel_id where indicated to subscribe to that channel’s events.
- The
destinationURL must be served on port 443; custom ports are not currently supported. - It can take up to one minute for a newly created webhook to work.
For information on creating a webhook, consult the creating a webhook section of the Webhooks Overview.
Callback structure
For webhook callback structure reference, see Webhook Events
Channel events
The following webhook events fire in response to actions that govern a store’s sales channels:
Channel event payloads take the form that follows:
Channel update events
Changes to any of the following fields trigger a store/channel/updated event:
- name
- external_id
- status
- is_listable_from_ui
- is_visible
- is_enabled (to be deprecated)
Carts
The following cart webhook events fire in response to actions that affect carts associated with a specific channel on a store:
Cart payload objects take the form that follows:
Cart line items
The following cart line item webhook events fire in response to actions that affect a cart items associated with a specific channel on a store:
Cart line items payload objects take the form that follows:
Categories
The following categories webhook events fire in response to actions that affect a specific channel on a store:
Categories payload objects take the form that follows:
Category trees
The following category tree webhook event fires in response to actions that affect a specific channel on a store:
Category tree payload objects take the form that follows:
Customers
The following customers webhook event fires in response to customer changes:
Customers payload objects take the form that follows:
Emails
The following emails webhook events fire in response to actions that affect a specific channel on a store:
Emails payload objects take the form that follows:
Metafields
The following metafield webhook events fire in response to actions that affect any channel on a store:
Metafields payload objects take the form that follows:
Notifications
The following notifications webhook events fire in response to actions that affect a specific channel on a store:
Notifications payload objects take the form that follows:
Orders
The following orders webhook events fire in response to actions that affect a specific channel on a store:
Order payload objects take the form that follows:
Pages
The following page-related webhook events fire in response to actions that affect a specific channel on a store:
Web pages payload objects take the form that follows:
For a complete reference of all BigCommerce webhook events and their callback payloads, see Webhook Events.
Price list assignments
The following price list assignment webhook event fires in response to price list assignment changes:
Price list assignment payload objects take the form that follows:
Product assignments
The following product assignment webhook events fire in response to actions that affect a specific channel on a store:
Product assignment payload objects take the form that follows:
Routes
The following routes webhook events fire in response to actions that affect a specific channel on a store:
Routes payload objects take the form that follows:
Scripts
The following scripts webhook events fire in response to actions that affect a site associated with a specific channel on a store:
Scripts payload objects take the form that follows:
Settings
The following settings webhook events fire in response to actions that affect a specific channel on a store:
Settings payload objects take the form that follows:
Sites
The following sites webhook events fire in response to actions that affect a site associated with a specific channel on a store:
Site payload objects take the form that follows:
Social media links
The following social media links webhook event fires in response to actions that affect a site associated with a specific channel on a store:
Social media link payload objects take the form that follows:
Themes
The following themes webhook events fire in response to actions that affect a site associated with a specific channel on a store:
Theme payload objects take the form that follows:
