Shrubbery Documentation

Shrubbery is a Consent-First Commitment OS that turns promises into mutually-agreed contracts and tracks delivery reliability.

This portal splits into three sections — two for product understanding, one for integration. The interactive HTTP API reference lives separately at /api-reference.

Guides

Narrative walk-throughs of the major product flows: how a commitment is captured, Handshaked, tracked, audited, and (when needed) renegotiated. Start here if you are new to the product.

Start with: Handshake Flow → Capture Flow → CFS Rules.

Concepts

Glossary appendix. One short page per domain term — Lead, Knight, Shrubbery, Handshake, Accord, Garden, Dossier, CFS, BYOK, and the lifecycle states. Cross-linked from the guides.

Key terms: Shrubbery, Handshake, Commitment Flow Score, BYOK.

API Reference

The interactive OpenAPI reference — request/response schemas, status codes, auth blocks, and a Test Request client — lives at /api-reference (Scalar viewer, auto-generated from the runtime Zod schemas via npm run docs:openapi).

Start with: API Getting Started → /api-reference.

Webhooks

Payload reference for incoming webhooks (POST /api/v1/inbox, POST /api/v1/sync) and outbound notifications.

Start with: Webhooks Overview.