API Reference

Zixflow.initialize({
  apiKey: 'YOUR_API_KEY',
});

Zixflow.identify({
  userId: 'user-123',
  traits: { email: 'user@example.com' }
});

Zixflow.clearIdentify();

Zixflow.track('button_clicked', { button_name: 'signup' });

Zixflow.screen('HomeScreen');

Zixflow.setProfileAttributes({ plan: 'premium' });

Zixflow.setDeviceAttributes({ app_version: '2.0.0' });

const status = await Zixflow.pushMessaging.showPromptForPushNotifications({
  ios: { sound: true, badge: true }
});

const listener = Zixflow.inAppMessaging.registerEventsListener((event) => {
  console.log('In-app event:', event);
});

// Remove listener
listener.remove();

Zixflow.inAppMessaging.dismissMessage();

interface ZixflowConfig {
  apiKey: string;
  logLevel?: ZixflowLogLevel;
  inApp?: {
  };
  autoTrackDeviceAttributes?: boolean;
  trackApplicationLifecycleEvents?: boolean;
  autoTrackScreenViews?: boolean;
  trackingApiUrl?: string;
}

enum ZixflowLogLevel {
  none = 'none',
  error = 'error',
  info = 'info',
  debug = 'debug'
}

enum ZixflowPushPermissionStatus {
  Granted = 'granted',
  Denied = 'denied',
  NotDetermined = 'notDetermined'
}

enum InAppMessageEventType {
  messageShown = 'messageShown',
  messageDismissed = 'messageDismissed',
  messageActionTaken = 'messageActionTaken',
  errorWithMessage = 'errorWithMessage'
}

interface InAppMessageEvent {
  eventType: InAppMessageEventType;
  deliveryId?: string;
  messageId?: string;
  actionName?: string;
  actionValue?: string;
}