Quick Start
From registration to your first push notification in 5 steps
Step 1. Create an Account
Go to the Notify Partners dashboard page and register. Registration requires an email and password (at least 8 characters).
After signing in, you will be taken to the admin panel.
Step 2. Create an Application
Go to the Applications section and click Create.
Specify:
- Name — the application name (displayed in analytics and available via the
{{app_name}}macro) - Link — the URL of your application or website
- Provider — the transport for delivering pushes:
| Provider | Use Case |
|---|---|
| Firebase (FCM) | Android applications |
| APNs | iOS applications |
| WebPush | Browsers (Chrome, Firefox, Safari) |
Upload the provider credentials — without them, sending is not possible:
- Firebase — the
google-services.jsonfile or a service account JSON key - APNs —
.p8key + Team ID + Bundle ID - WebPush — VAPID keys (generated automatically or uploaded manually)
Step 3. Integrate the SDK
Add the SDK to your application. The SDK automatically registers the device and obtains a token for sending notifications.
Web SDK
# Install via npm
npm install notify-partners-web-sdkPlace the Service Worker in the root of your site, then initialize the SDK:
import { NotifyPartnersSDK } from 'notify-partners-web-sdk';
NotifyPartnersSDK.init({
appId: 'YOUR_APP_ID',
});More details — in the Web SDK section.
Android SDK
Add the dependency to build.gradle:
implementation 'io.notify.partners:android-sdk:latest'Initialize in Application.onCreate():
NotifyPartnersSDK.init(this, appId = "YOUR_APP_ID")More details — in the Android SDK section.
iOS SDK
Add the package via Swift Package Manager:
https://github.com/SideQ-Org/notify-partners-ios-sdkInitialize in AppDelegate:
NotifyPartnersSDK.initialize(appId: "YOUR_APP_ID")More details — in the iOS SDK section.
Step 4. Create a Push Template
Go to the Push Templates section and click Create.
Add translations for the required languages — the service will automatically select the language based on the recipient's device settings.
Application and Task Macros
Substituted identically for all recipients:
| Macro | Description | Example |
|---|---|---|
{{app_name}} | Application name | Super Game |
{{app_id}} | Application ID | 42 |
{{app_link}} | Application link | https://example.com |
{{task_name}} | Scheduler task name | After Install 5 min |
{{task_id}} | Task ID | 7 |
Device Macros
Unique for each recipient:
| Macro | Description | Example |
|---|---|---|
{{external_id}} | User ID in your system | user_12345 |
{{language}} | Device language | en |
{{country}} | Country | US |
{{platform}} | Platform | android |
{{platform_name}} | Device model | Pixel 8 Pro |
{{timezone}} | Timezone | UTC+3 |
{{tag:key}} | Custom tag | [tag value] |
Personalization Operators
Operators are processed before sending and allow dynamic text modification:
| Operator | Description | Example |
|---|---|---|
{a|b|c} | Random variant selection | Get {100|200|500} coins! |
{Random=[min,max]} | Random number | You earned {Random=[10,100]} bonuses! |
{TimeOfDay} | Time of day by device timezone | Good {TimeOfDay}! |
{Date:DD.MM.YYYY} | Current date | Sale ends {Date:DD.MM.YYYY} |
{Weekday} | Day of week in device language | Come back on {Weekday}! |
{Push={A|B|C}} | Round-robin rotation between sends | {Push={Welcome!|Hey, we missed you!}} |
Step 5. Send a Push
Go to the Sends section and choose a type:
| Type | Description |
|---|---|
| Instant | Send right now to all devices or with filters |
| Scheduled (one-time) | A one-time send at a specific date and time |
| Weekly | Recurring on schedule — choose days of the week and time |
| Auto-push (by event) | Triggers automatically when an event occurs: registration, purchase, install, and others |
Select the application, template, configure audience filters (language, country, platform, tags) and click Send.
What's Next
- Push Packs — automatic push sets without manual configuration of each campaign
- API Reference — direct management via REST API
- Dashboard — detailed interface guide