API

SaaS users can automate with API keys and /v1/* endpoints.

Self-hosted and white-label operators additionally use /admin/* endpoints with admin credentials.

For SaaS key usage examples, see:

For self-hosted/white-label API automation, use the OpenAPI contract:

For LLM-driven automation, use the repo skill and pass your instance domain as the base URL:

User API Authentication

Authorization: Bearer <api_key>

Admin API Authentication (Self-Hosted / White-Label)

X-Admin-Password: <admin_password>

Common User Endpoints

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

Common Admin Endpoints

  • POST /admin/users
  • POST /admin/users/plan
  • POST /admin/plans
  • POST /admin/api-keys
  • POST /admin/tracked-contracts
  • GET /admin/backfill

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