API Reference

Alvero is an event-driven agent system. Every one of the 14 agents accepts and returns canonical events, scoped to a tenant and gated by a human-in-the-loop tier. Outbound PHI always requires human approval.

Agent contract

// Canonical event envelope — the contract every agent consumes.
interface CanonicalEventEnvelope {
  id: string;                 // "<source>_<ulid>"
  schemaVersion: 1;
  emittedAt: string;          // ISO-8601
  tenantId: string;           // 26-char ULID (validated at the Worker layer)
  source: "dentrix" | "stripe" | "plaid" | "alvero_internal";
  eventType: string;          // e.g. "dentrix.payment.received"
  idempotencyKey: string;
  payload: CanonicalEventPayload;   // discriminated union, Zod-validated
  safetyTier: "green" | "yellow" | "red";  // HITL routing
}

// Emit to the internal event bus (Cloudflare Worker fan-out).
await emitCanonicalEvent(event, env);

Canonical event types are published in github.com/alvero-dental/alvero-sample-integrations ↗ at src/shared/canonical-events.ts.

The 14 agent endpoints

AgentAcceptsReturnsHITL
bookkeeper.dentrix-ingestorDentrix API pullappointment.* / claim.*green
bookkeeper.bank-ingestorPlaid feedpayment.postedgreen
bookkeeper.document-ingestorR2 documentstructured line itemsyellow
bookkeeper.postingcanonical eventsjournal entriesyellow
bookkeeper.reconciliationpayment.postedreconciliation reportyellow
bookkeeper.closeposted ledgerdraft close packageyellow
bookkeeper.supervisoragent outputsanomaly flagsred
economic.cost-cutterledgercost recommendationsyellow
economic.revenue-hunterappointments/claimsrevenue opportunitiesyellow
economic.efficiencyschedulescheduling suggestionsyellow
economic.owner-brieftier outputsdaily briefinggreen
meta.pattern-minerde-identified metricsbenchmark insightsgreen
meta.per-tenant-coachtenant historyimprovement proposalsred
meta.agent-evaluatoragent metricspass/fail + rollbackred

Partner integrations

Public examples. Working sample integrations and the full canonical event definitions live at github.com/alvero-dental/alvero-sample-integrations ↗.