Documentation Index
Fetch the complete documentation index at: https://orbit-docs.devotel.io/llms.txt
Use this file to discover all available pages before exploring further.
Push Notifications API
Send push notifications to your end users’ iOS and Android devices through Apple Push Notification service (APNs) and Firebase Cloud Messaging (FCM). Orbit holds your provider credentials and exposes a single send endpoint that fans out to the right transport. Base path:/v1/push
Authentication: API key (X-API-Key) or session JWT.
Device tokens
Your mobile app registers each device’s push token after the user grants permission. Re-register on token rotation; APNs and FCM both rotate tokens periodically.| Method | Path | Purpose |
|---|---|---|
POST | /v1/push/register | Register a device token (mobile app SDK) |
POST | /v1/push/device-tokens | Register or update a token (server-side) |
GET | /v1/push/device-tokens | List tokens for the current user |
DELETE | /v1/push/device-tokens/{id} | Unregister a token |
Sending
| Method | Path | Purpose |
|---|---|---|
POST | /v1/push/send | Send a push notification to one or more contacts |
GET | /v1/push/notifications | List sent notifications |
Example — send to a single contact
See also
- Webhooks → push events —
push.delivered,push.opened,push.failed - Messaging API → unified send — push as one channel in a flow