Skip to main content
POST
Push Notifications
Send a push notification to one or more registered device tokens, or to every device subscribed to a topic.
See the API introduction to set up your base URL and private key before making requests.

Parameters

string
required
Your project ID from Project Settings in the dashboard.
string
required
Notification title shown to the user.
string
required
Notification message body.
string[]
One or more device tokens to deliver the notification to. Required unless sendByTopic is true.
boolean
default:"false"
Set to true to deliver to every device subscribed to topic instead of specific deviceTokens. Devices subscribe to a topic from your app using the SDK; create the topic itself from the Topics tab in the dashboard.
string
The topic key to broadcast to. Required when sendByTopic is true, ignored otherwise.
string
Name of a custom notification sound. The file itself must already be bundled inside your app project — Atelerix only passes the filename through to APNs/FCM, it doesn’t host or upload sound files. On iOS this is the sound file’s name with its extension (e.g. sound.mp3, .caf/.wav also supported); on Android it’s the resource name without an extension, matching a file under res/raw/ (e.g. sound). Leave empty to use the device’s default notification sound.
string
required
Your project slug from Project Settings.
string
required
Your private key from Project Settings.
string
default:"API"
Where the notification was sent from.
Never expose your private key in client-side code or public repositories. Send API requests from a trusted backend only.