DOCSEARCHbyAlgolia
Submit Docs

CalKeep Documentation

website·Indexed 30 days ago

https://docs.calkeep.com

Documentation for CalKeep, a platform for managing calendars, contacts, bookings, tasks, and pipelines. Includes guides on booking pages, CRM layers, availability profiles, and administrative tools such as SAML 2.0, SCIM 2.0, and versioned public APIs (/api/v1 and /api/v2). Covers integrations with Google Calendar, Outlook, Microsoft 365, and Exchange Online.

Tokens
21.6K
Snippets
17
Records
183
Agent score
50%

What's inside CalKeep

  1. Understand CalKeep API versioning and usage

    CalKeep provides two versioned public API routes for server-to-server integrations:

    • /api/v1: Used for the validated contact write workflow and existing V1 workspace, contact, and booking reads.
    • /api/v2: Used for read-only projections across the wider workspace object graph.

    Routes outside these versioned public APIs are used by CalKeep's internal clients and do not have a public stability guarantee.

  2. Manage team coordination and visibility in CalKeep

    CalKeep separates workspace-level coordination from personal calendar privacy. Managers can coordinate workspace members, roles, booking pages, availability, customer meetings, contacts, tasks, projects, processes, and follow-up reminders. They can also access audit events based on their role and plan. Connected personal calendars provide availability and conflict signals (blocking time when a rep is busy) without exposing private event titles, attendees, notes, or locations to managers.

  3. Understand the post-booking workflow

    Once a visitor completes a booking, the following actions occur automatically:

    1. Calendar Provisioning: The event is added to the host's target calendar (provided the provider has write authority).
    2. Contact Creation: A contact record is created or matched for the visitor.
    3. Notifications: Branded confirmation, reminder, and reschedule emails are sent to both parties.
    4. Webhooks: The booking.created webhook is triggered for integrated services.

  4. SAML 2.0 SSO Availability and Plan Requirements

    CalKeep supports SAML 2.0 single sign-on exclusively on the Enterprise plan. It is compatible with any SAML-compliant Identity Provider (IdP), and has been specifically tested against Microsoft Entra ID, Okta, and OneLogin.

  5. CalKeep product capabilities overview

    CalKeep is a unified platform for solo professionals and small teams that integrates the following capabilities:

    • Calendar connections: Unified view to review and enable supported provider calendars.
    • Booking pages: Public scheduling links with custom branding.
    • Contacts (CRM): Sync provider contact books, deduplicate entries, share with teammates, and manage follow-up reminders.
    • Tasks & projects: Includes an inbox, project boards, and recurring tasks with calendar drag-to-schedule functionality.
    • Processes: Templated workflows that automatically generate tasks on a schedule.
    • Branded experience: Custom logos, colors, and copy across all customer-facing surfaces.

  6. Manage and source contacts in CalKeep

    Contacts are managed under the People section in the sidebar. Contacts are created or updated via the following sources:

    • Bookings: Auto-creates or matches a contact by email for every booking.
    • Provider contact books: Syncs from Google and Microsoft after access is requested, granted, and discovery succeeds. Sync, writeback, and delete-at-source are disabled by default.
    • Manual creation: Via People → New contact.
    • Import: Bulk-import via CSV or vCard.
    • Public API: Via POST /api/v1/contacts (available on Business+ tier).

  7. Use the CalKeep FREE plan

    The CalKeep FREE plan is permanently available for a single user. It includes 1 booking page and 1 event type. Users can upgrade to PRO or BUSINESS tiers via the Azure Marketplace to access more seats and advanced features.

  8. Manage availability using profiles

    An availability profile is a named set of bookable hours and rules (e.g., "client work hours", "office hours"). Profiles allow you to decouple your working hours from specific event types, enabling different schedules for different types of meetings (e.g., discovery calls open weekdays, but renewal conversations only on Tuesday mornings). Profiles are managed under the Availability section in the sidebar.

  9. Manage workspace settings via the Admin Hub

    The Admin Hub organizes workspace administration into three outcome-based groups:

    1. Workspace management: Used for managing team members, invitations, seats, and workspace branding.
    2. Security & identity: Used for configuring authentication policies, SAML, SCIM provisioning, and accessing the workspace audit log. Note: Sensitive changes in this section require a currently enrolled factor and recent MFA verification.
    3. Integrations & services: Used for the Integration Center, payment readiness, AI provider settings, and meeting-notetaker configuration. This includes API tokens, webhooks, and provider connections.

  10. Understand CalKeep's master and exception recurrence model

    CalKeep normalizes recurring events into a 'master event' and an 'exception' model. A recurring series is stored as a single master record containing an iCalendar RRULE (e.g., "every Tuesday 2 PM"). Individual occurrences are computed at read time based on this rule. When a specific occurrence is modified (e.g., rescheduled or cancelled), CalKeep creates an exception record linked to the master via recurrenceId and originalStartTime. This exception overrides the specific slot while the master rule continues to run.

  11. CalKeep platform availability and architecture

    CalKeep is available across four primary surfaces that share a single workspace and authentication layer:

    • Web: Accessible at calkeep.com; mobile-first responsive design.
    • iOS: Native app built with React Native and Expo.
    • Android: Native app built with React Native and Expo.
    • Desktop (Windows & macOS): Electron wrapper.

  12. Manage CalKeep workspace settings via the Admin Hub

    The Admin Hub is the central location for managing Workspace management, Security & identity, and Integrations & services. Note that the presence of a control in the Admin Hub does not guarantee that the underlying service is configured or healthy.