Skip to main content

Developer Portal Service — Event Schemas

Version: 1.0 Status: Draft Owner: Product + Developer Relations (DevRel) Last Updated: 2026-04-20


1. Intent

Catalogue every NATS JetStream event the Developer Portal produces and consumes, with versioned payload schemas, retention class, and downstream consumers. Events drive consumption analytics (analytics-service), spend metering (billing-service), and audit (compliance-engine).

2. Produced Events

  • devportal.key.created.v1TBD
  • devportal.key.revoked.v1TBD
  • devportal.verify.requested.v1TBD
  • devportal.verify.delivered.v1TBD
  • devportal.verify.approved.v1TBD
  • devportal.verify.failed.v1TBD
  • devportal.verify.spend_cap_hit.v1TBD
  • devportal.sdk.released.v1TBD
  • devportal.sdk.downloaded.v1TBD

3. Consumed Events

  • auth.events.api_key.revoked.v1 — for downstream cache invalidation — TBD
  • compliance.template.approved.v1 — to keep Verify template catalogue in sync — TBD
  • sms.dlr.inbound.v1 — for Verify SMS delivery state — TBD

4. Payload Schemas

  • TBD (JSON schema per event with required fields, optional fields, enums)

5. Retention

EventClassRetention
devportal.key.*audit7 years
devportal.verify.*operational90 days
devportal.sdk.*audit7 years

6. Versioning Policy

  • TBD