Version: 1.0
API Reference
Orb's API is built with the following principles in mind:
- Predictable developer experience: Where applicable, the Orb API uses industry-standard patterns such as cursor-based pagination and standardized error output. To help with debugging in critical API actions, the API always strives to provide detailed and actionable error messages. Aliases such as external customer IDs aid in fast integration times.
- Reliably real time: Orb's event-based APIs, such as event ingestion are designed to handle extremely high throughput and scale with concurrent load. Orb also provides a real-time event-level credits ledger and a highly performant webhooks architecture.
- Flexibility at the forefront: Features like timezone localization and the ability to amend historical usage show the flexible nature of the platform.
You can download the latest OpenAPI spec here.
Authentication
HTTP: Bearer Auth
API Keys can be issued in the Orb's web application. Orb recommends that separate API keys be created for each service that you'd like to attribute actions to separately (e.g. a key for ingesting events, and a key for manipulating customer balances automatically). This also allows you to rotate keys and revoke access more flexibly.
| Security Scheme Type: | http |
|---|---|
| HTTP Authorization Scheme: | bearer |