lumen

Description:

lumen

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
copied to clipboard
Usage #
Initialize the plugin
import 'package:lumen/lumen.dart';

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

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

runApp(const MyApp());
}

copied to clipboard
Identify a user
final identifyData = IdentifyData(
email: "[email protected]", // required
first_name: "john",
last_name: "doe",
phone_number: "0123456789",
device_id: "device ID");

Lumen.identify("<< user-identifier >>", identifyData);
copied to clipboard
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);
copied to clipboard
Contributing #

Fork it
Clone your fork (git clone [email protected]:MY_USERNAME/lumen-flutter.git && cd lumen-flutter)
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'feat: Added some feature')
Push to the branch (git push origin my-new-feature)
Create new Pull Request