Quickstart
Sign-up, app creation, channel setup, SDK installation and your first notification — a test push in 15 minutes.
This guide walks through every step from zero to your first notification. The Getting started wizard in the dashboard (/<org>/getting-started) runs the same steps in the order app → channel (or simulation) → SDK snippet → live device detection → test push, and shows device registration live.
1. Sign-up and organization
- Sign up with email and password at
https://<dashboard>/register(sign-in with Google/GitHub may also be enabled). Click the link in the verification email; in local development, emails appear in Mailpit (http://localhost:8025). - In the onboarding step, enter your organization name. Every new organization starts with a 14-day
startertrial; after that thefreeplan (10k subscribers, 100k messages/month) continues. Plans and quotas: Billing. - Optional: enable two-factor authentication under Account → MFA (it can be made mandatory at the organization level).
2. Create an app
Dashboard → Apps → New app (or the Getting started wizard). Once the app is created, you can see its app_… ID under App settings; client SDKs work with this ID.
Via the API (with an org-wide admin key):
curl -X POST https://api.pushizo.com/v1/apps \
-H "Authorization: Bearer hs_live_…" -H "Content-Type: application/json" \
-d '{"name":"Store"}'3. Channel setup
Enable at least one channel under App settings → Channels. If you have no real credentials, every channel also works with the simulation (mock) provider; the delivery pipeline runs end to end, but the notification does not reach a device.
| Channel | Requirements | Verification |
|---|---|---|
| Web Push | Just enable it (the VAPID pair is generated automatically), sender subject (mailto: or https://) | active immediately |
| iOS Push | APNs .p8 key, Key ID, Team ID, Bundle ID, environment (sandbox / production) | APNs connection test |
| Android Push | Firebase service account JSON | FCM connection test |
| SMTP / SES / Resend details, sender address (SPF/DKIM/DMARC recommended) | Provider test | |
| SMS | Twilio or Netgsm details | Provider test |
Secret fields (p8, service account, password, API key) are stored encrypted and never returned in any response. API: PUT /v1/apps/{app_id}/channels/{channel} + POST …/validate (admin).
4. SDK installation
The Developer → SDK Setup page gives you snippets with your App ID and API address filled in. The fastest path is web:
<script src="https://api.pushizo.com/sdk-web/PushizoSDK.js" async></script>
<script>
window.PushizoDeferred = window.PushizoDeferred || [];
PushizoDeferred.push(async (Pushizo) => {
await Pushizo.init({ appId: 'app_…', apiUrl: 'https://api.pushizo.com' });
});
</script>PushizoSDKWorker.js at the site root:
const apiUrl = new URL(self.location.href).searchParams.get('apiUrl') || 'https://api.pushizo.com';
importScripts(`${apiUrl}/sdk-web/PushizoSDKWorker.js`);Bind Pushizo.Notifications.requestPermission() to a button; once permission is granted, a subscription is created and a web_push record appears under Dashboard → Subscriptions. For mobile and server SDKs, see the SDK guides: iOS (Pushizo.initialize), Android (Pushizo.initialize(context, appId, options)), Flutter (Pushizo.initialize), Node (new Pushizo({ apiKey })), PHP (new Client([...])).
Call Pushizo.login('user_42') as soon as you know the user's identity; this merges all devices of the same user, and you can target them from the server with external_id.
5. Your first notification
From the dashboard
Subscriptions → mark the record as a Test device → Messages → Send test push. The notification arrives on the device; tapping it opens the page/app, and the queued → sent → received → opened timeline appears in Message Tracking. The Getting started wizard measures this step against a ≤ 15 minute target.
From the API
Create a key with the notifications:write scope under Organization → API keys (the raw key is shown only once).
curl -X POST https://api.pushizo.com/v1/notifications \
-H "Authorization: Bearer hs_live_…" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: ilk-bildirim-1" \
-d '{
"app_id": "app_…",
"target": { "test_devices_only": true },
"headings": { "tr": "Merhaba", "en": "Hello" },
"contents": { "tr": "Pushizo çalışıyor", "en": "Pushizo is working" },
"url": "https://pushizo.com"
}'
# 202 → { "id": "msg_…", "status": "queued", "recipients_estimate": 1, "external_id_missing": [] }target.test_devices_only: true sends to test devices only; for real targeting use include_external_ids, include_aliases, included_segments or all: true. Status: GET /v1/notifications/{message_id} (counts.sent, delivered, opened…), deliveries: GET /v1/notifications/{message_id}/deliveries.
The same request with Node:
import { Pushizo } from '@pushizo/node';
const hs = new Pushizo({ apiKey: process.env.HS_API_KEY!, appId: 'app_…', baseUrl: 'https://api.pushizo.com' });
const result = await hs.notifications.create({
idempotency_key: 'ilk-bildirim-1',
target: { test_devices_only: true },
headings: { tr: 'Merhaba' },
contents: { tr: 'Pushizo çalışıyor' },
});
console.log(result.id, result.status);6. Next steps
- Events and conversions:
Pushizo.Session.sendEvent('purchase', { sku: 'A1' }, 49.9)orPOST /v1/apps/{app_id}/events; markis_conversionin the event definition. - Segments and campaigns: Dashboard → Audience → Segments; scheduling and A/B tests with Campaigns (A/B testing).
- Webhooks: receive delivery and subscription events on your server (Webhooks).
- Journeys: event/segment-triggered automation (Journeys).
- Email, SMS, in-app, notification inbox: Messaging.
- Coming from a legacy provider: migration guide.