Data-driven automation messaging for growth and retention.

Lumen

The Lumen flutter plugin allows you to seamlessly identify and track user attributes and events on your app. Plus other perks.

Features

  • Identify users
  • Track user events
  • Update user properties

Getting started

  • Setup your Lumen account.

  • Retrieve your API key.

Follow the steps below to retrieve your api key.

  • Log in to your lumen dashboard.
  • Navigate to Settings
  • Select the API Key tab to view and copy your key.
  • Install the plugin
flutter pub add lumen

Usage

Initialize the plugin

import 'package:lumen/lumen.dart';

const lumenApiKey = "<< your-api-key >>";

void main() {
  Lumen.init(lumenApiKey);

  runApp(const MyApp());
}

Identify a user

final identifyData = IdentifyData(
    email: "johndoe@example.com", // required
    first_name: "john",
    last_name: "doe",
    phone_number: "0123456789",
    device_id: "device ID");

Lumen.identify("<< user-identifier >>", identifyData);

Track an event

After identifying users, you can now capture their actions like "Product Clicked" or "Product Viewed" with other custom properties.

final customTrackProperties = {"value": "1233"};

Lumen.track("<< user-identifier >>", "<< event-name >>", customTrackProperties);

Contributing

  1. Fork it
  2. Clone your fork (git clone git@github.com:MY_USERNAME/lumen-flutter.git && cd lumen-flutter)
  3. Create your feature branch (git checkout -b my-new-feature)
  4. Commit your changes (git commit -am 'feat: Added some feature')
  5. Push to the branch (git push origin my-new-feature)
  6. Create new Pull Request

Libraries

lumen