Skip to main content

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.
MethodPathPurpose
POST/v1/push/registerRegister a device token (mobile app SDK)
POST/v1/push/device-tokensRegister or update a token (server-side)
GET/v1/push/device-tokensList tokens for the current user
DELETE/v1/push/device-tokens/{id}Unregister a token

Sending

MethodPathPurpose
POST/v1/push/sendSend a push notification to one or more contacts
GET/v1/push/notificationsList sent notifications

Example — send to a single contact

curl -X POST https://orbit-api.devotel.io/api/v1/push/send \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "contact_id": "ct_abc123",
    "title": "Your order has shipped",
    "body": "Tracking #1Z999AA10123456784",
    "data": { "order_id": "ord_42" },
    "deep_link": "myapp://orders/ord_42"
  }'
The response identifies which devices were notified and which transport (APNs / FCM) was used per device.

See also