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.
DashboardGet an API key
Get StartedEventsToolsChangelog
Get StartedEventsToolsChangelog
  • Welcome
    • Overview
    • Quickstart
  • Concepts
    • Event envelope
    • Receiving webhooks
    • Signature verification
    • Retries and backoff
    • Testing
LogoLogo
DashboardGet an API key
Concepts

Testing

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

Retries and backoff

Built with

Two ways to exercise a webhook endpoint without touching production data: the dashboard’s Send test event button, and pivotal_test_ API keys.

DASHBOARD TEST EVENTS
  1. Open Admin → Developer → Webhooks.
  2. Pick your endpoint, click Send test event.
  3. Choose an event type. The dashboard fills in a realistic payload — you can edit the JSON before sending.
  4. The delivery shows up in the Logs tab with full request and response.

Test events from this button carry livemode: false and a fake resource id. They will not appear in your Pivotal app’s activity feed.

TEST MODE KEYS

pivotal_test_… keys write to the same workspace, but outbound integration side effects (Slack, Resend, downstream webhook deliveries to your live receivers) are suppressed. Webhook endpoints flagged test_mode: true receive these events; live endpoints do not.

See Test mode for the full rules.

LOCAL DEVELOPMENT

Pair the Webhooks dashboard with a local tunnel — see Local tunneling. The flow:

  1. Run your receiver on localhost:8787.
  2. Start ngrok or Cloudflare Tunnel.
  3. Register the tunnel URL as a Webhook endpoint, flagged Test mode.
  4. Fire events from the dashboard.