API

Most SaaS teams can use the Dashboard only.

If you are automating subscription lifecycle, backfills, or delivery operations in a self-hosted/white-label deployment, use the OpenAPI contract:

Authentication

Authorization: Bearer <api_key>

Common Endpoints

  • POST /v1/subscriptions
  • GET /v1/subscriptions
  • GET /v1/events
  • GET /v1/deliveries
  • POST /v1/backfill
  • POST /v1/webhook-test

Use /openapi.yaml as the source of truth for request/response schemas. Use /api-docs.html for human-readable endpoint exploration.