HOW IT WORKS
1. Create a project
The planned console issues scoped credentials for separate environments. Sensitive API keys remain on your backend and must never be embedded in browser JavaScript.
2. Register a destination
Your app registers a Web Push subscription, an FCM token or an APNs token, then associates it with your own internal user ID where appropriate.
3. Send or schedule
Submit a notification with a target, title, body, URL or deep link and optional schedule. Include an idempotency key when retrying from a backend job.
4. Handle responses
A request being accepted means it has entered the service workflow, not that the person received it. Monitor provider errors, token invalidation and client-reported opens separately.
Example request (planned)
This is an illustrative contract to explain the design. The API does not yet accept requests.
POST /v1/notifications
Idempotency-Key: appointment-452
{
"project_id": "proj_demo",
"user_id": "customer_128",
"title": "Appointment reminder",
"body": "Your appointment is tomorrow",
"schedule_at": "2026-11-15T14:00:00-03:00",
"expires_at": "2026-11-15T15:00:00-03:00"
}The service is in development. Any API shown is a proposed interface, not an active endpoint.