# OnRamp API

> REST API for the OnRamp customer-onboarding platform: projects, tasks,
> playbooks, comments, custom data fields, users, and webhooks. JSON over
> HTTPS, bearer-token auth, UUID identifiers.

## Reference

- [API reference](/docs): every endpoint, schema-driven from [/openapi.json](/openapi.json)
- [Interactive Swagger UI](/docs/swagger): try calls with your API key
- [Postman collection](/docs/postman-collection.json): importable, every endpoint pre-wired for a bearer API key

## Guides

- [Onboarding health dashboard](/docs/guides/onboarding-health-dashboard): See completion %, overdue work, and at-risk accounts across every onboarding — in a spreadsheet or a Monday-morning email — without opening OnRamp.
- [At-risk onboarding radar (Slack digest)](/docs/guides/at-risk-radar): One Slack message every morning listing the onboardings that are stalled or overdue — with links straight to the project — instead of finding out in the QBR.
- [Mirror OnRamp without polling (webhooks + delta sync)](/docs/guides/mirror-and-delta-sync): Keep a live copy of your OnRamp projects and tasks in your own database with ~99% fewer API calls — webhooks tell you what changed, you fetch just that.
- [Customer mention & comment alerts in Slack](/docs/guides/help-request-alerts): The moment a customer comments or @mentions your team in OnRamp, a Slack alert appears with the message, the task, and a link — no more found-it-Friday.
- [Completion-gated provisioning & data handoff](/docs/guides/completion-gated-provisioning): The moment a customer finishes the gating task — security review signed, kickoff form filled — your systems provision automatically and post the confirmation back into OnRamp.
- [Webhook payloads & delivery reference](/docs/guides/webhook-payloads): Every event OnRamp can send you, the exact JSON it delivers, and the delivery guarantees (ordering, duplicates, retries) your receiver should be built around.
- [Zero-touch kickoff — create projects from your own systems](/docs/guides/zero-touch-kickoff): A signup, a signed contract, or a closed deal in your systems spawns a ready-to-run onboarding project in OnRamp — pre-filled, assigned, and deduplicated. Works for one project or a 50-site rollout.
- [Two-way conversation bridge (OnRamp ↔ Slack)](/docs/guides/two-way-slack-bridge): Customer comments land in a per-project Slack thread; your team replies in Slack and the reply appears back in OnRamp — one conversation, two windows.