docs / 07

Webhooks

Outbound webhooks are not available yet. This page records the current state and what to use instead.

parcel does not currently push outbound webhooks to customers. The only webhook endpoint is the inbound Stripe billing webhook; do not rely on customer event delivery.

Current state

No events are pushed to customers today. The API is pull-only: you read coverage, records and usage on demand with the endpoints documented in the API reference.

Stripe billing webhook

Stripe delivers billing lifecycle events (checkout completion, subscription changes and paid invoices) to POST /api/stripe/webhook. Every delivery is verified against the Stripe signature header with the configured webhook secret; a bad or missing signature is rejected with 400. This endpoint is for Stripe, not for API customers.

Stay current today

  • Poll GET /api/coverage for national and per-state coverage totals.
  • Poll GET /api/counties with status and state filters for county-level changes.
  • Poll GET /api/usage for the calling token's balance and recent ledger.
curl https://parcel.reeeally.ai/api/coverage

Roadmap

When outbound webhook delivery ships, this page will document the subscription mechanism, the event envelope, the signature header and the retry policy. Until then, customers should poll the API; the inbound Stripe webhook above is internal billing plumbing, not a customer event stream.

For county requests and support, use the Help Center at support.reeeally.ai.