Push notifications

Push has two halves:

• Devices register their token — automatically, with the Flutter SDK — tied to the person's identity, language and tags.
• Sends come from the console (campaigns, automations, A/B tests, schedules) or from your backend (transactional sends to users, segments or filters).

1. Configure providersCopy Anchor Link

In the console under Push → Settings, add credentials once per environment:

2. Register devices (Flutter)Copy Anchor Link

await Nexus.init(const NexusConfig(apiKey: 'nxs_live_xxx', pushEnabled: true));

That is the whole integration. The SDK asks for permission, gets the token, registers it for the current person, re-registers on refresh, shows notifications while the app is in the foreground (with its own native code — no extra packages), and reports opens.

App prerequisites (the standard Firebase setup):

• Android — google-services.json, and apply the Google Services Gradle plugin (id("com.google.gms.google-services")) in android/app/build.gradle(.kts).
• iOS — GoogleService-Info.plist; enable Push Notifications and Background Modes → Remote notifications; upload the APNs key to Firebase.
• Web — initialise Firebase yourself and pass pushWebVapidKey.

const NexusConfig(apiKey: '…', pushEnabled: true, pushAutoRequestPermission: false);
// … at the right moment, after your own explainer screen:
await Nexus.instance.push.start();

await Nexus.instance.push.registerToken(token, platform: PushPlatform.android);
// raw APNs token: provider: PushProvider.apns
Nexus.instance.push.reportOpen(message.data);
await Nexus.instance.push.unregister();   // on sign-out

Language, tags and opensCopy Anchor Link

final push = Nexus.instance.push;
await push.setLanguage('ar');                 // campaigns arrive in this language
await push.setTag('role', 'client');          // target with segments
await push.setTags({'plan': 'pro', 'city': 'erbil'});
await push.removeTag('city');

push.onOpened = (open) {
  // open.campaignId, open.actionId (button), open.actionUrl, open.data
  if (open.actionUrl != null) launchUrl(Uri.parse(open.actionUrl!));
};

Localization falls back from en-US to en, then to the campaign's default language, then to the base message.

3. Send from your backendCopy Anchor Link

$nexus->push()->notification()
    ->title('Your order shipped')
    ->body('Track it in the app')
    ->image('https://cdn.example.com/box.png')
    ->data(['screen' => '/orders/42'])
    ->button('track', 'Track', ['url' => 'https://example.com/track'])
    ->iosBadge(1)
    ->toUser('user_1')
    ->send();   // ['sent' => …, 'failed' => …, 'recipients' => …]

$nexus->push()->sendToUser('user_1', ['title' => 'Welcome 👋']);

TargetingCopy Anchor Link

Targets combine as a union:

Per-platform optionsCopy Anchor Link

Campaigns & automationsCopy Anchor Link

In the console, Push composes campaigns with a live preview, translations (Localize), rich options, scheduling and A/B variants, and reports delivery and open rates. Automations send when a product event is tracked. Open rates count campaign sends only — API and automation sends have no open attribution.

ReferenceCopy Anchor Link

Flutter · JavaScript · PHP · Python · .NET · REST