Docs
Ctrl+K

Changelog

API v1 version tracking, compatibility promise, deprecation policy and changelog.

Version Policy#

The Bokko Public API follows semantic versioning. The current stable version is: v1.

  • Major change (v1 → v2): non-backwards compatible — separate URL prefix, temporary parallel execution.
  • Minor change (v1.0 → v1.1): backwards compatible expansion (e.g., new optional field, new endpoint).
  • Patch: bug fix, internal change, the contract does not change.

What is the Contract#

The following constitute part of the API contract — integrators can rely on these:

  • Endpoint URL and HTTP method.
  • Names and types of request and response fields (for required fields).
  • Error code values, their HTTP status and retryable flags.
  • Capability names and their scope.
  • Webhook event names and the value of the payload.event field.

What is NOT part of the Contract#

We do not guarantee stability for the following:

  • Adding or removing optional fields (if they were not required previously).
  • Error message text (message field) — only the code is stable.
  • Meta extension fields (meta.truncated, meta.returnedSlots, etc.).
  • Rate limit quota values (the structure is stable, the values are not).
  • Internal Firestore paths, Cloud Function names.

Current v1 Contract Summary#

Contract dimenzióDarabszám
Dokumentált endpoint14
Stabil error code27
Webhook event8
Capability8
Rate limit group5

Deprecation Policy#

If an endpoint, field, or capability is phased out:

  1. We communicate the deprecation at least 6 months in advance.
  2. Affected endpoints receive a Deprecation HTTP response header (RFC 8594).
  3. The planned shutdown date is indicated by the Sunset HTTP response header.
  4. Email notification to the Pro subscriber's registered contact email.
Tipp
There is currently no active deprecation. If the first deprecation occurs, the activation of backend headers and the email pipeline will be part of the deprecation event. The above policy is a communication promise, not a description of already deployed infrastructure.

v1.0.0 — 2026-05-05 — Initial Publication#

The first stable public release. The numbers below apply to this release and remain fixed — they do not update automatically if the contract expands.

  • 14 documented endpoints
  • 27 stable error codes
  • 8 webhook events
  • 8 capabilities
  • 5 rate limit groups

Endpoints:

  • POST /availability/search
  • GET /bookings
  • POST /bookings
  • GET /bookings/{bookingId}
  • POST /bookings/{bookingId}/cancel
  • GET /bookings/{bookingId}/events
  • GET /services
  • GET /staff
  • GET /subscription
  • GET /webhooks/config
  • PUT /webhooks/config
  • DELETE /webhooks/config
  • POST /webhooks/config/rotate-secret
  • GET /webhooks/deliveries