Skip to main content
The version is in the path: /v1. Within v1 we only make additive changes:
  • new endpoints, new optional parameters, new event types;
  • new fields in responses;
  • new values in status enums, new error codes.
Write your client to ignore fields it does not know and to handle unknown enum values gracefully. Webhook endpoints only receive the event types they subscribed to, so new event types never surprise you. We will never, within v1:
  • remove or rename a field, endpoint or scope;
  • change a field’s type, such as turning a decimal string into a number;
  • make an optional parameter required.
A breaking change means a new version (/v2) running side by side with v1. We announce it well in advance, and v1 keeps working while you move over. The OpenAPI document is generated from the same contracts that BrandGate’s servers validate against, so the reference always matches what the API does.