Skip to content

Existing V1 registrations

Existing Public API registrations retain their V1 payload contract, including registrations created through a V2 REST route before payload versioning was introduced. The creation route alone does not identify the payload contract. Retrieve the registration through the V2 management route to read its immutable payload_version; V1 output keeps its original fields.

V1 deliveries use X-Bsport-Webhook-Payload-Version: 2026-08-22, historical event names such as offer-update, and the V1 resource representation. The complete historical event catalogue remains available.

Manage these registrations through /api/v1/management/webhook-registrations/: list, retrieve, update, or disable them. New V1 registration creation returns HTTP 410 with code WHR-002. Updating the destination, subscribed event, or active state preserves both the signing secret and payload version. Retries and replay also retain the same payload version.

The V2 management route can also maintain historical V1 registrations. Their event names remain historical V1 names such as offer-update, even on that route; use the V1 catalogue when choosing a replacement subscribed event. Changing the management route does not change the payload contract.

To migrate an integration, first prepare the receiver for the V2 contract, then create a V2 registration through /api/v2/management/webhook-registrations/. Disable the corresponding V1 registration when the new integration is ready. A registration cannot be converted from V1 to V2 with PATCH.