winr_flutter_sdk 2.0.0

WINR Flutter SDK — A sweepstakes and engagement SDK for Flutter apps. Add daily streaks and sweepstakes campaigns to your app with a few lines of code.

WINR Flutter SDK

Drop-in sweepstakes, prizing, and gamification for your Flutter app

---

Overview

WINR lets you add daily-entry sweepstakes and prize experiences to your app in under 20 lines of code. The entire UI — branding, theming, copy, and prize configuration — is managed server-side from the WINR dashboard. You integrate once; your marketing team controls the rest.

Key capabilities:

• Daily entry sweepstakes — Users earn entries every day they engage
• V2 auto-open experience — The bottom-drawer experience opens itself on the first app-open of each day and grants entries automatically
• Streak ladder + milestone accelerators — Escalating daily entry rewards, with server-configurable milestone bonuses
• Winner announcements — "WE HAVE A WINNER!" banner and winner dialog, driven by the giveaway's latestWinner
• Visit mode — A never-resetting streak variant for low-frequency apps
• Push reminders — Drive re-engagement with daily nudges (FCM)
• Server-driven branding — Logo, prize image, and primary color update without app releases
• GDPR/CCPA compliant — Built-in consent flows, RTD opt-out, and user data deletion
• Analytics forwarding — Route SDK events to your existing analytics stack

Quick Start

import 'package:winr_flutter_sdk/winr_flutter_sdk.dart';

// 1. Configure the SDK
final config = WINRConfiguration(
  apiKey: 'YOUR_API_KEY',
  bundleId: 'com.example.myapp',
  environment: WINREnvironment.production,
  user: WINRUser(
    id: 'user_123',
    firstName: 'Jane',
    lastName: 'Doe',
  ),
);
await WINR.configure(config);

// 2. Attach the SDK navigator key so the experience can auto-open on the
//    first app-open of each day
MaterialApp(navigatorKey: WINR.navigatorKey, home: ...);

// 3. (Optional) Present the experience manually at any time
await WINR.present(context);

Installation

Add the SDK to your pubspec.yaml as a git dependency:

dependencies:
  winr_flutter_sdk:
    git:
      url: https://github.com/AVAFLI/winr_flutter_sdk.git
      ref: main

pub.dev: The package is not yet published to pub.dev — winr_flutter_sdk: ^2.0.0 will not resolve until it is.

Then run:

flutter pub get

Note: Contact AVAFLI to obtain an API key.

Configuration

Initialize the SDK with your user and environment settings:

final config = WINRConfiguration(
  apiKey: 'winr_live_xxxxxxxxxx',
  bundleId: 'com.example.myapp',
  environment: WINREnvironment.production,
  user: WINRUser(
    id: 'user_abc123',
    firstName: 'Jane',
    lastName: 'Doe',
    phone: '[phone]',  // optional
  ),
  options: WINROptions(
    logging: LoggingLevel.debug,
    enablePushReminders: true,
    analyticsAdapter: myAdapter,  // optional
  ),
);

final success = await WINR.configure(config);

WINRConfiguration

Parameter	Type	Required	Description
apiKey	String	✅	Your WINR API key from the dashboard
bundleId	String	✅	App bundle ID (e.g., com.example.myapp)
environment	WINREnvironment	—	.production (default)
user	WINRUser	✅	The authenticated user
options	WINROptions?	—	Optional behavior toggles

WINRUser

Parameter	Type	Required	Description
id	String	✅	Unique, stable user identifier
firstName	String	✅	User's first name
lastName	String	✅	User's last name
phone	String?	—	Phone number in E.164 format

Email: The SDK captures email through its own opt-in UI. Do not pass email via WINRUser.

Present the Experience

The V2 experience presents itself automatically once per calendar day (first app-open of the day) when WINR.navigatorKey is attached to your MaterialApp. Auto-open respects the server-side kill switch (sdkConfig.experience.autoOpenEnabled), an unregistered-impression cap (default 3), and the RTD opt-out.

You can also launch the bottom-drawer experience manually:

final grant = await WINR.present(context);

if (grant != null) {
  print('${grant.baseEntries} base + ${grant.bonusEntries} bonus = ${grant.total} total');
}

The method returns a DailyEntryGrant when entries were claimed during the session, or null if the user dismissed without a new claim.

Push Notifications

Drive re-engagement with daily reminders. Publishers forward their FCM token to WINR:

1. Setup Firebase Cloud Messaging

Follow the Firebase setup guide for Flutter.

2. Forward FCM Token

import 'package:firebase_messaging/firebase_messaging.dart';

// Get the FCM token and forward it to WINR
final fcmToken = await FirebaseMessaging.instance.getToken();
if (fcmToken != null) {
  await WINRPushNotificationManager.instance.didReceiveRegistrationToken(fcmToken);
}

// Listen for token refreshes
FirebaseMessaging.instance.onTokenRefresh.listen((token) {
  WINRPushNotificationManager.instance.didReceiveRegistrationToken(token);
});

Or the one-line equivalent:

FirebaseMessaging.instance.onTokenRefresh.listen(WINR.registerPushToken);

3. Upload FCM Service Account Key

Upload your FCM service account key via the WINR Dashboard to enable push notifications.

4. Enable Push Reminders

Set enablePushReminders: true in WINROptions during configuration.

Customization

The V2 experience is hardcoded to the WINR design; publishers customize exactly three things through the WINR Dashboard:

• Logo — Shown in the drawer header
• Prize image — Art for the dashboard prize card
• Primary color — Accent for CTAs, streak tiles, and highlights

Plus prize configuration (active giveaways, ladder, milestones) and push reminder schedules.

Changes apply instantly across all app installations without requiring an app update.

Analytics

Forward WINR events to your existing analytics stack:

class MyAnalyticsAdapter implements AnalyticsAdapter {
  @override
  void track(String eventName, [Map<String, dynamic>? parameters]) {
    // Forward to Segment, Amplitude, Mixpanel, etc.
    analytics.track(eventName, parameters);
  }
}

// Pass during configuration
await WINR.configure(WINRConfiguration(
  // ... other config
  options: WINROptions(
    analyticsAdapter: MyAnalyticsAdapter(),
  ),
));

Events emitted by the SDK:

• winr_sdk_configured — SDK configured successfully
• winr_experience_presented — User opened the WINR experience
• winr_daily_entry_claimed — Daily entries awarded (auto-claimed on open). Params: day, entries, plus weekly_bonus, monthly_bonus, and milestone_day when awarded.
• winr_experience_dismissed — User closed the WINR experience without a new claim

GDPR / Delete User Data

Support GDPR/CCPA deletion requests:

await WINR.deleteUserData();

This permanently removes all user data, entries, preferences, and consent records from WINR servers.

API Reference

Core Methods

Method	Returns	Description
WINR.configure(config)	Future<bool>	Initialize the SDK with user and settings
WINR.present(context)	Future<DailyEntryGrant?>	Launch the WINR bottom-drawer experience
WINR.optOut()	Future<void>	RTD opt-out — permanently silence the experience
WINR.deleteUserData()	Future<void>	Permanently delete all user data

Push Notifications

Method	Returns	Description
WINRPushNotificationManager.instance.didReceiveRegistrationToken(token)	Future<void>	Forward FCM token to WINR

For detailed API documentation, see the WINR Docs.

Links

• Dashboard: https://avafli-website.web.app/sdk/dashboard
• Documentation: https://avafli-website.web.app/sdk/flutter
• Support: [e-mail]

---

© 2026 Avafli. All Rights Reserved.