Flutter SDK

Dart · Flutter 3.10+ · Material 3

Overview

The Avafli Engagement SDK lets you add daily-entry sweepstakes and prize experiences to your app with a single configuration call. The SDK automatically opens the experience on the first app-open of each day, captures the user, and claims their daily entries — no scheduling or session logic on your side. You customize your logo, prize image, and brand color from the Avafli dashboard; everything else is managed server-side.

Requirements

Flutter	3.24+
Dart	3.5+
Platform	iOS 13+ / Android API 21+
Publisher API Key	Contact info@avafli.com

Installation

Add to pubspec.yaml

Add the dependency to your pubspec.yaml:

dependencies:
  avafli_sdk: ^3.1.6

Then install the package:

flutter pub get

Quick Start

One call at app launch is the entire integration:

main.dart

import 'package:avafli_sdk/avafli_sdk.dart';

await Avafli.configure(AvafliConfiguration(
  apiKey: 'YOUR_API_KEY', // debug builds: use your avafli_test_ sandbox key
  bundleId: 'com.example.myapp',
  user: AvafliUser(
    id: 'user_123',             // only id is required — pass whatever identity you have
    firstName: 'Jane',
    lastName: 'Doe',
    email: 'jane@example.com',  // include it when you have it — pre-fills & locks the capture form
  ),
  // Nobody signed in? use user: AvafliUser.guest
  options: AvafliOptions(
    logging: LoggingLevel.error,  // LoggingLevel.debug while integrating
    enablePushReminders: true,    // then forward tokens: Avafli.registerPushToken(token)
  ),
));

// Attach the navigator key: MaterialApp(navigatorKey: Avafli.navigatorKey, ...)
// Splash that clears the nav stack? holdAutoOpen() before configure, releaseAutoOpen() after.

Attach the SDK’s navigator key — MaterialApp(navigatorKey: Avafli.navigatorKey) — and the experience opens itself on the first app-open of each day. There is no manual launch API; presentation timing, the daily cadence, and dismissal are fully managed by the SDK. If your app boots through a splash screen or auth gate that ends by clearing the navigation stack (Get.offAll, pushAndRemoveUntil), call Avafli.holdAutoOpen() before configuring and Avafli.releaseAutoOpen() once your main screen is mounted, so the drawer isn’t destroyed by your boot navigation.

Push Notifications

Drive re-engagement with daily reminders. Forward your FCM token to the SDK:

import 'package:firebase_messaging/firebase_messaging.dart';

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

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

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

Branding

Branding is configured server-side — no code changes needed. Publishers customize three things — their logo, the prize image, and their primary brand color — via the Customize Experience section in the publisher dashboard. Everything else is designed and managed by Avafli. Changes take effect immediately in the SDK.

Analytics

Connect your analytics system to track user engagement:

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

  @override
  void setUserProperty(String name, String value) {
    analytics.setUserProperty(name, value);
  }

  @override
  void identify(String userId) {
    analytics.identify(userId);
  }
}

// Pass during configuration
await Avafli.configure(AvafliConfiguration(
  apiKey: 'YOUR_API_KEY',
  bundleId: 'com.example.myapp',
  user: AvafliUser(id: 'user_123'),
  options: AvafliOptions(
    analyticsAdapter: MyAnalyticsAdapter(),
  ),
));

Account deletion in your app

If your app has its own delete-account flow, call optOut() from it so the user's Avafli data is erased along with their account. Users can also delete their data themselves at any time from the Privacy Policy screen inside the experience — no integration required.

// From your delete-account flow
await Avafli.optOut();

Testing? Your dashboard also shows a avafli_test_ sandbox key. Use it in debug builds: identical behavior against the production backend, but users and entries land in an isolated sandbox — your testers can never enter your real giveaway.

SDK Features

Escalating Streak Ladder with Milestone Accelerators

Daily or Visit-Based Streak Modes

Winner Announcements & Celebrations

Auto-Open on First Daily App-Open

Email Capture & Age Gate (18+)

Push Notifications (FCM)

Server-Driven Configuration

GDPR Compliance

Offline Resilience

Built-in Analytics Support

Custom Logo, Prize Image & Brand Color

Cross-platform (iOS/Android)

Full API Reference & Code Examples

View the complete documentation on GitHub including API reference, code examples, and advanced configuration.

View on GitHub Contact Us