.md to the URL./llms-full.txt. Short index: /llms.txt.my.pivotal.app/api/v1/openapi.json.The Pivotal API and webhooks expose the same primitives the Pivotal app uses internally: customers, contacts, onboardings, and tasks. Use them to mirror customers from your CRM, attach contacts as you collect them, drive onboardings through their phases, and stream events into your stack.
Bearer auth, JSON in, JSON out. Every endpoint mirrors what the app does internally. Cursor pagination, idempotency keys, soft deletes, ISO 8601 dates, snake_case everywhere.
Subscribe to events, pick the types you care about, receive signed payloads. Delivered via Svix with 24h exponential backoff and a replay button in the dashboard.
End-user help for the Pivotal app. Setup, customers, onboardings, integrations, Workbench, and Ask Pi. The non-developer-facing surface.
Three first-class objects. Tasks live under onboardings.
npm i @pivotal/api. Strict types from the OpenAPI spec.
pip install pivotal. Same shape as the TS client.
Generate a client in any language from the live spec.
Replay-safe POSTs. Drop a key on the header, retry without dupes.
pivotal_test_ keys write to the same workspace, isolated by a flag.
Single-file context, .md URL suffix, and Open-in-Claude links.
Live (pivotal_…) or test (pivotal_test_…). Scoped to one workspace.
Key to customer to contact to onboarding in three minutes.
Every endpoint, every shape. Run requests from inside the docs.
Subscribe an endpoint, pick events, verify signatures, replay failures.
Email help@pivotal.app with the request you ran, the response body, and the response headers. For something time-sensitive, include “P0” in the subject.