Skip to content
BookifyCall
Developer docs: Versioning and changelog

Versioning and changelog

What we promise not to break, and what changed when.

Versioning policy

The version is in the path: /api/v1/external. Within a version we only make changes that do not break a well-behaved client:

  • adding endpoints, optional parameters, response fields and webhook events;
  • adding values to fields documented as open lists (statuses, outcomes, failure reasons).

Removing or renaming a field or endpoint, changing a type, or changing how authentication works needs a new version. Build clients that ignore unknown fields and treat unknown enum values gracefully.

Deprecation

A version moves from active to deprecated to sunset to retired. We announce a deprecation at least six months before retirement, publish a migration guide with the new version, and contact accounts still using the old one. While deprecated, every response carries Deprecation: true and a Sunset date header.

Version 1 is active, with no deprecation planned.

Changelog

    • New: GET /me, GET /usage, GET /analytics/summary and GET /insights/summary.
    • New: scheduled calls (GET, POST /scheduled-calls, GET and DELETE /scheduled-calls/:id).
    • Call detail adds analysis (structured AI summary) and appointmentId; lead detail adds sourceCall and appointments; appointments add callId.
    • Lists accept updatedSince, sort and order; leads filter by temperature, source and dates; appointments by agentId and includeCancelled; 429 responses carry Retry-After.
    • Published the OpenAPI 3 spec and these docs.
    • Version 1 at /api/v1/external, path-compatible with the previous /api/external: change only the base URL.