API overview

The Pushrail REST API exposes the customer-facing surface of the platform: event ingestion, destination configuration, routing, deliveries, replay, schemas, and the audit trail. The API is generated from the same ts-rest contract the production servers run, so reference and reality cannot drift.

Base URL

https://api.pushrail.io

There is a single base URL for all calls. The environment a request targets (Development, Staging, or Production) is determined by the API key's prefix (pr_dev_, pr_sta_, pr_pro_), not by the URL. A key only ever reaches the data in its own environment.

What "public" means

Only routes explicitly marked customer-facing on the contract appear in this reference. Internal endpoints (auth, billing, onboarding, tenancy, platform admin) are excluded by default and do not appear in openapi.json.

Download the spec

openapi.json is the machine-readable OpenAPI 3.1 document. Import it into Postman, generate clients with openapi-generator, or diff it across releases to track API changes.