zixflow 1.1.3

An official flutter plugin for Zixflow, an automated messaging platform.

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:

1. Log in to your Zixflow account
2. Go to Settings → Developers → API Keys
3. 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': '[e-mail]',
    '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: [e-mail]

License

MIT