Get started

Versioning

The REST API and webhook payloads are versioned by date. Within a version, changes are additive only.

Current version

The current version is 2026-10-01. Every API response carries it in the X-Rabbitblaze-Version header, and every webhook payload in its apiVersion field.

Pinning a version

Send X-Rabbitblaze-Version: 2026-10-01 with your requests to make the version you built against explicit. A version that doesn’t exist answers 400:

400 Bad Request

{  "error": {    "supportedVersions": [      "2026-10-01"    ],    "code": "unsupported_version",    "message": "API version \"2019-01-01\" isn't supported. Use 2026-10-01."  }}

What can change

Within a version we only make backwards-compatible changes:

new endpoints, new optional parameters and new response fields;
new values in enums documented as extensible, such as webhook topics and conversation event types;
new webhook topics you can subscribe to.

Removing or renaming a field, or changing its type or meaning, only happens in a new dated version, announced in the changelog with time to migrate. Write clients that ignore fields they don’t know.