Skip to content

Quickstart

Ten minutes from zero to your first delivered push.

1. Create a workspace and app

Sign up in the dashboard, create an app, and note its appId. Web push VAPID keys are generated automatically; upload FCM / APNs credentials in the app's Setup step for mobile.

2. Create an API key

Dashboard → Settings → API keys. Scopes: read, write, send (add admin for org management). The key is shown once.

3. Add the SDK

For web:

html
<script src="/wingblaze-sdk.js"></script>
<script>
  WingBlaze.init({ appId: "...", apiUrl: "https://api...", ingestUrl: "https://ingest..." });
  await WingBlaze.enablePush();          // permission + device registration
  await WingBlaze.login("user-123");     // bind your user id
  await WingBlaze.addTags({ plan: "pro" });
  await WingBlaze.trackEvent("purchase", { amount: 42 });
</script>

Serve wingblaze-sw.js at your site root. Native and cross-platform apps: see SDKs — the API surface is identical on all seven platforms.

4. Send your first campaign

Dashboard → Composer: write a message, pick an audience, Send now — or via the API:

bash
curl -X POST https://api.../v1/apps/$APP_ID/messages \
  -H "Authorization: Bearer $API_KEY" -H "Content-Type: application/json" \
  -d '{"title": "Hello", "body": "First campaign"}'

Then create a campaign with the returned messageId and POST /campaigns/:id/send. The scheduler fans out; the API never sends directly.

5. Watch it land

Campaign stats (sent → delivered → opened → clicked) are live on the campaign page and at GET /v1/apps/:appId/campaigns/:id/stats.

Next

  • Concepts — subscribers, devices, tags, segments
  • Journeys — automate the follow-up
  • Channels — connect email, SMS, WhatsApp, Telegram, RCS

Data hosted in Southeast Asia (asia-southeast1).