Zixflow Flutter SDK
The official Zixflow SDK for Flutter.
Installation
Add to your pubspec.yaml:
dependencies:
zixflow: ^1.1.3
Then run:
flutter pub get
Quick Start
1. Get Your API Key
Your API key can be found in your Zixflow account:
- Log in to your Zixflow account
- Go to Settings → Developers → API Keys
- Copy your API key
2. Initialize the SDK
import 'package:flutter/material.dart';
import 'package:zixflow/zixflow.dart';
void main() async {
WidgetsFlutterBinding.ensureInitialized();
// Initialize Zixflow SDK
final config = ZixflowConfig(
apiKey: 'YOUR_API_KEY',
logLevel: LogLevel.debug,
);
await Zixflow.initialize(config: config);
runApp(MyApp());
}
3. Identify Users
// Identify a user
Zixflow.instance.identify(
userId: 'user-123',
traits: {
'email': 'user@example.com',
'name': 'John Doe',
'plan': 'premium',
},
);
4. Track Events
// Track events
Zixflow.instance.track(
name: 'purchase_completed',
properties: {
'amount': 99.99,
'product_id': 'ABC123',
},
);
// Track screen views
Zixflow.instance.screen(
title: 'Home Screen',
properties: {'section': 'main'},
);
Features
- User Identification: Identify users and track their activity
- Event Tracking: Track custom events and screen views
- Push Notifications: Send targeted push notifications via FCM
- In-App Messaging: Display in-app messages and manage inbox
- Location Tracking: Location-based messaging capabilities
Documentation
For complete documentation, see:
- Integration Guide - Complete setup guide
- API Documentation
Platform Requirements
- Flutter: 2.5.0 or higher
- Dart: 2.17.6 or higher
- iOS: 13.0 or higher
- Android: API 21 (Android 5.0 Lollipop) or higher
Support
- GitHub Issues: Report issues
- Email: apps@zixflow.com
License
Libraries
- config/in_app_config
- config/location_config
- config/push_config
- config/zixflow_config
- data_pipelines/_native_constants
- data_pipelines/zixflow_method_channel
- data_pipelines/zixflow_platform_interface
- extensions/map_extensions
- extensions/method_channel_extensions
- location/_native_constants
- location/method_channel
- location/platform_interface
- messaging_in_app
- messaging_in_app/_native_constants
- messaging_in_app/inbox_message
- messaging_in_app/inline_in_app_message_view
- messaging_in_app/method_channel
- messaging_in_app/notification_inbox
- messaging_in_app/platform_interface
- messaging_push/_native_constants
- messaging_push/method_channel
- messaging_push/platform_interface
- zixflow
- zixflow_config
- zixflow_enums
- zixflow_inapp
- zixflow_plugin_version
- zixflow_sdk
- zixflow_widgets
- Zixflow Flutter SDK widgets library