Skip to content

DEVDOCS-6557 - Webhooks for B2B Events (Phase 1) #1173

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bc-Vince wants to merge 9 commits into
base: main
Choose a base branch
from
Open

DEVDOCS-6557 - Webhooks for B2B Events (Phase 1) #1173

Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
155fa70
DEVDOCS-6557 - Webhooks for B2B Events (Phase 1)
bc-Vince Dec 2, 2025
d1e8ad4
DEVDOCS-6557 - Webhooks for B2B Events (Phase 1)
bc-Vince Dec 2, 2025
edc84c1
Apply suggestions from code review
bc-Vince Dec 2, 2025
0b6568c
DEVDOCS-6557 - Webhooks for B2B Events (Phase 1)
bc-Vince Dec 8, 2025
d46ba19
Merge branch 'main' into DEVDOCS-6557
bc-Vince Dec 8, 2025
f1ebce7
Apply suggestions from SME review
bc-Vince Dec 16, 2025
ff9ace4
Apply suggestions from code review
bc-Vince Dec 16, 2025
442cfee
Merge branch 'main' into DEVDOCS-6557
bc-Vince Dec 16, 2025
a1c0ed9
Update docs/integrations/webhooks/events/b2b-edition.mdx
bc-Vince Dec 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion docs/b2b-edition/about/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,15 @@ The V2 API is deprecated, and it does not support many of B2B Edition's newer fe

## API authentication and context

Requests to the B2B Edition REST Management V3 API are always in the context of the server. To authenticate V3 API requests, generate a server to server authToken via one of the following methods:
<Callout type="important">
As of September 30, 2025, the B2B Edition API `authToken` is deprecated and replaced by the standard BigCommerce API `X-Auth-Token` used together with a new header `X-Store-Hash`. This change only applies to Server-to-Server requests. Storefront requests remain unchanged.

While `authToken` authentication is not expected to be fully sunset in the near future, it is advised to migrate to the new system as soon as possible to prevent disruption of functionality.

The server and path for B2B REST Management API endpoints remains the same.
</Callout>

Requests to the B2B Edition REST Management V3 API are always in the context of the server. To authenticate V3 API requests, create a BigCommerce API authentication token in the control panel with the B2B Edition scope enabled. Alternatively, you can generate a B2B Edition-only server to server authToken via one of the following methods:

* Create an API account from [B2B Edition's settings](https://support.bigcommerce.com/s/article/B2B-Edition-Settings)
* Generate a token via the [Create a Server to Server Token](/b2b-edition/apis/rest-management/authentication#get-a-server-to-server-token) endpoint
Expand Down Expand Up @@ -260,6 +268,12 @@ Storefront GraphQL responses contain all the fields specified in the original qu
}
```

## Webhooks

You can use a store-level or app-level API account to [register and subscribe](/docs/webhooks/webhooks/manage-webhooks-single) to B2B Edition webhook events. Webhooks a resource-efficient alternative to polling the API for keeping your app up-to-date.

See [B2B Edition Events](/docs/integrations/webhooks/events/b2b-edition) for a complete list of supported webhook events.

## Resources

* [About BigCommerce APIs](/docs/start/about)
Expand Down