Docs

Technical reference

Connect Calberry to your site and tools; use the generated API reference for exact endpoint contracts.

This section covers workspace webhooks, signature verification, embedding and integration recipes. In the API, a booking link is represented by the Funnel resource. Identifiers and event names remain unchanged across languages.

Endpoint contracts

Use the existing generated reference rather than copying endpoint schemas from an article:

The base URL is https://api.calberry.ai; resource paths use /v1. The reference identifies required scopes, request/response schemas and whether an operation is stable or beta. Stable coverage includes slots, creating/rescheduling/cancelling bookings, lead creation/listing, reading funnels and webhook management. Other exposed operations are beta unless the reference says otherwise.

Authentication and safe writes

API access and workspace webhooks require Pro and workspace permission. Owners/admins manage keys under Development → API. Store the key when it is issued; choose only the scopes the integration needs. API-key management itself uses a signed-in owner/admin session.

Keep private API keys on a server. Do not put one in an embed, website JavaScript, a public repository or a query string. Public booking/embed routes use a separate visitor flow.

For writes, send an Idempotency-Key. Keep the same key when retrying the same operation with the same validated data. Use a new key for a new intended action. Reusing a key with conflicting data produces an idempotency conflict.

Handle the documented error envelope and rate-limit responses. Respect Retry-After when provided, paginate lists and use the documented delta filters. A booking response and a completed Google Calendar sync are separate outcomes.

Choose an integration

Workspace webhooks deliver events independently of sequences. WhatsApp is coming soon.

On this page