B2B Edition Webhooks

B2B Edition is BigCommerce’s all-in-one solution that offers enterprise-level B2B functionality to businesses of all types and sizes. It enables business owners to facilitate their B2B operations online and to provide customers with self-service account capabilities and seamless transactions.

This page is a reference for B2B Edition webhooks and it assumes that you’re familiar with webhooks. For a general introduction to webhooks, see Webhooks Overview.

Note: B2B Edition currently does not support storefront channel-specific webhooks.

Creating a webhook

To create a webhook, send a request to the Create a webhook endpoint. You must use a BigCommerce store- or app-level API account to authenticate the request; it does not support the API tokens created in your B2B Edition API Account settings. Your API account must have the B2B Edition scope set to modify.

The following example creates a webhook that subscribes to creation events for Company accounts.

POST https://api.bigcommerce.com/stores/{{STORE_HASH}}/v3/hooks
X-Auth-Token: {{ACCESS_TOKEN}}
Content-Type: application/json
Accept: application/json
{
  "scope": "store/company/created", 
  "destination": "https://example.com/webhooks", // replace with your HTTPS endpoint URL
  "is_active": true
}

For information on creating a webhook, consult the creating a webhook section of the Webhooks Overview.

Callback structure

For information on webhook callback payload properties, see Webhook Events.

Companies

The following webhooks fire in response to changes to Company account records. You can use them to track new Company account requests across your storefront channels, updates to Company information, or changes in a Company’s activity status.

{
  "scope": "store/company/created",
  "store_id": "123456",
  "data": {
    "company_id": 1234
  },
  "hash": "352e4afc6dd3fc85ea26bfdf3f91852604d57528",
  "created_at": 1561482670,
  "producer": "stores/{store_hash}"
}

Company Users

The following webhooks fire in response to changes to Company users. These are B2B customers with a Buyer Portal account connected to a Company. Changes to B2C customers, guest shoppers, and Super Admins do not trigger these webhooks.

{
  "scope": "store/company/user/created",
  "store_id": "123456",
  "data": {
    "company_id": 123456,
    "user_id": 321
  },
  "hash": "352e4afc6dd3fc85ea26bfdf3f91852604d57528",
  "created_at": 1561482670,
  "producer": "stores/{store_hash}"
}

Company Addresses

The following webhooks fire in response to changes to addresses saved to Company accounts. Changes to addresses on B2C customer accounts use Customers webhooks instead.

{
  "scope": "store/company/address/created",
  "store_id": "123456",
  "data": {
    "company_id": 123456,
    "address_id": 1234
  },
  "hash": "352e4afc6dd3fc85ea26bfdf3f91852604d57528",
  "created_at": 1561482670,
  "producer": "stores/{store_hash}"
}

Super Admins

The following webhooks fire in response to changes to Super Admins, sales staff who assist Company users from the Buyer Portal.

{
  "scope": "store/superadmin/created",
  "store_id": "123456",
  "data": {
    "user_id": 1234
  },
  "hash": "352e4afc6dd3fc85ea26bfdf3f91852604d57528",
  "created_at": 1561482670,
  "producer": "stores/{store_hash}"
}

Quotes

The following webhooks fire in response to changes to quotes. You can use them to track quote lifecycle events such as creation, updates, status changes, and deletions.

{
  "created_at": 1561482670,
  "store_id": "1025646",
  "producer": "stores/{store_hash}",
  "scope": "store/quote/created",
  "hash": "352e4afc6dd3fc85ea26bfdf3f91db8c86f74f09",
  "data": {
    "type": "quote",
    "id": 123
  }
}

Resources

Related Articles

• Webhooks Overview
• Webhook Events
• Webhooks Reference
• B2B Edition Reference