Menu
Platform
AI
App store purchases
Credits
Database
Flags
Generated Assets
Monitoring
Notifications
Organizations
Payments
- Payments
- Payments quickstart
- Checkout policies
- Checkout sessions
- Customer subscriptions
- Entitlement grants
- Exchange rates
- Licence keys
- Licence tokens
- Merchant accounts
- Portal sessions
- Price catalogs
- Revenue
- Revenue facts
- Revenue sources
- Tax threshold statuses
- Usage events
- Usage invoices
- Usage meter prices
- Usage meters
- Usage reservations
- Usage settings
- Usage tiers
Queues
Realtime
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
On this page
Notifications
What Recipients, Preferences and Inbox Items are, and the calls each one serves.
Notifications reaches your users by push, SMS and an in-app inbox. A Recipient is one of your users with their addresses and device tokens; a Preference records which channels may carry each topic; an Inbox Item is one entry of their in-app feed, delivered live over a realtime channel and paged here.
#Where it is served
Notifications is served by Sylphx Notify on the one API. Every call is
under https://api.sylphx.com/v1/orgs/{org}/projects/{project}/envs/{env}/
and takes a Sylphx key with the scope its method names in the API reference
(keys and scopes).
#The resources
| Collection | What it is |
|---|---|
| recipients | A Recipient is one of a customer's users, across channels: email addresses, phone numbers, and device tokens. |
| preferences | A Preference is a recipient's choice for one topic: which channels may carry it. |
| inbox items | An Inbox Item is one entry of a recipient's in-app feed. |
Each link opens the collection's methods, with the path, scope, request, response and examples of every call.