Glossary
Terms a new engineer or operator has to know. Where a term maps to a flow or concept, follow the link.
Tenancy & identity
Section titled “Tenancy & identity”- Tenant — a customer business operating on the platform; everything is
scoped to one. Surfaces as a
slugon public URLs. - Business — the scheduler-side record for a tenant (
business.id). Drives provisioning and convergence. - Organization (WorkOS org) — the auth-side tenant in WorkOS. Provisioning
mints one keyed on
business.id; users authenticate into their org. See Auth. - Slug — the URL-safe tenant identifier in public routes (
/api/public/:slug/*). - stoken — a short-lived scoped token for SSE streams, replacing the old
?token=query param (security migration). Minted per-stream, expires quickly.
Contracts & APIs
Section titled “Contracts & APIs”- Contract-drift / drift-500 — because scheduler-api serializes responses
through Zod (
@nexus/scheduler-contracts), any response that violates its contract throws and the client gets a 500 rather than a malformed 200. The contract is a hard runtime gate. See the Booking flow. - Public surface — unauthenticated, slug-scoped booking API (
/api/public/:slug/*). - Portal surface — customer-session-scoped API (
/api/portal/*) for a customer’s own account/bookings.
Provisioning & sync
Section titled “Provisioning & sync”- Provisioning — standing up a new business across the 5 systems (scheduler, WorkOS, Stripe, Directus, Vendure). Runs as a Temporal workflow.
- Convergence — the idempotent workflow that drives a business toward its desired state across all systems (the generalization of provisioning).
- Reconciliation — the daily scanner that reads the mirror caches to detect drift. Backfills write those caches; the scanner reads them — they are layered, not redundant.
- Backfill — a one-shot script that writes/prunes a mirror cache.
Infrastructure
Section titled “Infrastructure”- Temporal — durable workflow engine for provisioning/convergence, Railway-hosted. See Environments.
- BullMQ — Redis-backed job queues (reminders, notifications, jobs).
- Neon — managed Postgres in production.
- R2 — Cloudflare’s S3-compatible object storage (assets); MinIO locally.
catalog:protocol — pnpm workspace catalog; shared dependency versions are pinned once inpnpm-workspace.yamland referenced as"dep": "catalog:".
Surfaces
Section titled “Surfaces”- portal — the Innerlight admin portal (internal staff).
- portal-business — the business owner portal (tenant owners/admins).