For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
my.pivotal.appGet an API key
Get StartedEventsToolsChangelog
Get StartedEventsToolsChangelog
  • Welcome
    • Overview
    • Quickstart
  • Concepts
    • Event envelope
    • Receiving webhooks
    • Signature verification
    • Retries and backoff
    • Testing
LogoLogo
my.pivotal.appGet an API key
Welcome

Webhooks

|View as Markdown|Open in Claude|
Was this page helpful?
Edit this page
Next

Webhooks quickstart

Built with

Stream Pivotal events to your own systems. Subscribe to an endpoint, pick the events you care about, and we’ll POST a signed payload whenever they happen. Deliveries are retried for 24 hours with exponential backoff.

Outbound delivery runs on Svix. The signing headers, retry schedule, and verification libraries are the standard Svix ones — drop in any Svix SDK and it works against Pivotal without custom code.

SUBSCRIBE
  1. Open Admin → Developer → Webhooks in your workspace.
  2. Click Add endpoint, paste your HTTPS URL, pick the event types to receive.
  3. Copy the signing secret — Svix shows it once. Store it in your secret manager.
  4. Test from the dashboard with Send test event. The same UI lists every past delivery with status, payload, and a one-click Replay.
WHAT TO READ NEXT
Quickstart

Receive your first event in under five minutes. Local tunnel + signing verification.

Event envelope

The standard shape every payload arrives in. id, type, timestamp, org, data.object.

Receiving webhooks

Node/Express and Python/FastAPI handlers, ready to copy.

Signature verification

HMAC verification in TypeScript and Python.

Retries and backoff

24h exponential schedule. What counts as success. When delivery gives up.

Testing in test mode

Fire real events from pivotal_test_ keys without polluting production data.

EVENT REFERENCE

Fifteen event types ship today, grouped by resource. Each page documents the payload shape, when it fires, a copyable JSON example, and common use cases.

Customer events (6)

Created, updated, archived, health score dropped, at risk, churned.

Contact events (1)

Created.

Onboarding events (7)

Created, phase changed, state changed, at risk, back on track, launched, completed.

Task events (1)

Completed.