# Pivotal developer documentation

<ul>
  <li>
    For clean Markdown of any page, append 

    <code>.md</code>

     to the URL.
  </li>

  <li>
    Pull the whole site as a single context: 

    <a href="/llms-full.txt"><code>/llms-full.txt</code></a>

    . Short index: 

    <a href="/llms.txt"><code>/llms.txt</code></a>

    .
  </li>

  <li>
    Every page has 

    <strong>Open in Claude</strong>

     / 

    <strong>Open in ChatGPT</strong>

     in the action bar.
  </li>

  <li>
    OpenAPI spec lives at 

    <a href="https://my.pivotal.app/api/v1/openapi.json"><code>my.pivotal.app/api/v1/openapi.json</code></a>

    .
  </li>
</ul>

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.

***

SURFACES

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.

***

DATA MODEL

Three first-class objects. Tasks live under onboardings.

<defs>
  <path d="M0,0 L10,5 L0,10 z" fill="currentColor" />
</defs>

<rect x="40" y="80" width="200" height="60" />

Customer

central record

<rect x="310" y="20" width="200" height="60" />

Contacts

N per customer

<rect x="310" y="140" width="200" height="60" />

Onboardings

N per customer

<rect x="580" y="140" width="160" height="60" />

Tasks

N per onboarding

***

DEVELOPER TOOLS

`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 (`/llms-full.txt`), `.md` URL suffix, Open in Claude / ChatGPT on every page.

***

## Get started

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](mailto:help@pivotal.app)** with the request you ran, the response body, and the response headers. For something time-sensitive, include "P0" in the subject.

## Instructions for AI Agents

- For clean Markdown of any page, append `.md` to the page URL
- For a complete documentation index, see https://docs.pivotal.app/llms.txt
- For full documentation content in one file, see https://docs.pivotal.app/llms-full.txt
- For section-specific indexes, append `/llms.txt` to any section URL
- For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.pivotal.app/_mcp/server

## Products

- [REST API](https://docs.pivotal.app/rest-api/llms.txt)
  - [Introduction](https://docs.pivotal.app/rest-api/welcome/introduction.mdx)
  - [Quickstart](https://docs.pivotal.app/rest-api/welcome/quickstart.mdx)
  - [Authentication](https://docs.pivotal.app/rest-api/welcome/authentication.mdx)
  - [Rate limits](https://docs.pivotal.app/rest-api/welcome/rate-limits.mdx)
  - [Errors](https://docs.pivotal.app/rest-api/welcome/errors.mdx)
- [Webhooks](https://docs.pivotal.app/webhooks/llms.txt)
  - [Overview](https://docs.pivotal.app/webhooks/overview.mdx)
  - [Quickstart](https://docs.pivotal.app/webhooks/quickstart.mdx)
  - [Event envelope](https://docs.pivotal.app/webhooks/envelope.mdx)
  - [Receiving webhooks](https://docs.pivotal.app/webhooks/receiving.mdx)
  - [Signature verification](https://docs.pivotal.app/webhooks/signing.mdx)
- [Product docs](https://docs.pivotal.app/product/llms.txt)
  - [Overview](https://docs.pivotal.app/product/setup.mdx)
  - [Create your workspace](https://docs.pivotal.app/product/setup/create-your-workspace.mdx)
  - [Invite your team](https://docs.pivotal.app/product/setup/invite-your-team.mdx)
  - [Roles and permissions](https://docs.pivotal.app/product/setup/roles-and-permissions.mdx)
  - [Branding and logos](https://docs.pivotal.app/product/setup/branding-and-logos.mdx)