Beacon

Event conventions

View as Markdown

Event conventions

Naming, deduplication, and versioning for Stripe events.

reference • updated 2026-03-15

Naming convention

  • Use <domain>.<resource>.<action> for public event names.
  • Avoid ambiguous verbs (updated) without business context.
  • Keep event names stable to reduce consumer breakage.

Keys and deduplication

TypeRecommended fieldPurpose
Technical eventevent.iddedupe provider re-deliveries
Business operationcheckout.session.id (or equivalent functional id)enforce logical uniqueness
Mutable requestIdempotency-Keyprevent double execution on retries

Versioning rules

  1. Breaking changes require a new schema/event version.
  2. New fields should be optional by default.
  3. Deprecations should include an explicit communication window in changelog.
json
{
  "event_id": "evt_123",
  "event_type": "billing.checkout.completed",
  "occurred_at": "2026-03-15T12:00:00Z",
  "organization_id": "org_123",
  "payload": {}
}