Cueflow.init()

Initialize Cueflow with user data. This must be called before any other methods.

Syntax

Cueflow.init(user)

Parameters

user (required)

An object containing user information:

Property	Type	Required	Description
id	string	Yes	Unique identifier for this user (your internal user ID)
email	string	No	User's email address
name	string	No	Display name
phone	string	No	Phone number
avatarUrl	string	No	URL to profile image
role	string	No	User's role (e.g., "admin", "member")
plan	string	No	Subscription plan (e.g., "free", "pro", "enterprise")
signedUpAt	string	No	ISO 8601 date when user signed up
[custom]	any	No	Any additional custom attributes

Basic Example

Cueflow.init({
  id: 'user-123',
  email: '[email protected]',
  name: 'Jane Smith'
});

Full Example

Cueflow.init({
  // Required
  id: 'user-123',

  // Standard properties
  email: '[email protected]',
  name: 'Jane Smith',
  phone: '[phone]',
  avatarUrl: 'https://example.com/avatars/jane.jpg',
  role: 'admin',
  plan: 'pro',
  signedUpAt: '2024-01-15T10:30:00Z',

  // Custom attributes (any key-value pairs)
  company: 'Acme Inc',
  teamSize: 50,
  industry: 'technology',
  isEnterprise: true,
  onboardingComplete: true
});

When to Call

Call init() after your user is authenticated and you have their information:

// After login
async function handleLogin() {
  const user = await authenticateUser();

  Cueflow.init({
    id: user.id,
    email: user.email,
    name: user.fullName,
    plan: user.subscription.plan
  });
}

Important Notes

Call Only Once

init() should only be called once per page load. Calling it again will show a warning:

Cueflow.init({ id: 'user-123' });
Cueflow.init({ id: 'user-123' }); // Warning: "Cueflow: Already initialized"

If you need to update user data after initialization, use Cueflow.update().

ID is Required

The id property is mandatory. Without it, initialization will fail:

// This will fail
Cueflow.init({
  email: '[email protected]'
});
// Warning: "Cueflow: user.id is required"

// This works
Cueflow.init({
  id: 'user-123',
  email: '[email protected]'
});

Use Consistent IDs

Always use the same id for the same user across sessions. This ensures:

• Targeting rules work correctly

• Dismissals are remembered

• Event history is tracked properly

// Good - use your database user ID
Cueflow.init({ id: user.databaseId });

// Bad - random or session-based IDs
Cueflow.init({ id: Math.random().toString() });

Custom Attributes

Any properties beyond the standard ones become custom attributes:

Cueflow.init({
  id: 'user-123',
  email: '[email protected]',

  // These are custom attributes
  company: 'Acme Inc',
  department: 'Engineering',
  accountAge: 365,
  hasCompletedOnboarding: true
});

Custom attributes can be used for targeting in the Cueflow dashboard:

• company equals "Acme Inc"

• accountAge greater than 30

• hasCompletedOnboarding equals true

Attribute Types

Type	Example	Targeting Operators
String	company: "Acme"	equals, not equals, contains
Number	teamSize: 50	equals, greater than, less than
Boolean	isPremium: true	equals, not equals

TypeScript

If using TypeScript, you can type your user object:

interface CueflowUser {
  id: string;
  email?: string;
  name?: string;
  phone?: string;
  avatarUrl?: string;
  role?: string;
  plan?: string;
  signedUpAt?: string;
  [key: string]: unknown;
}

declare global {
  interface Window {
    Cueflow: {
      init(user: CueflowUser): void;
      update(data: Partial<CueflowUser>): void;
      track(event: string, properties?: Record<string, unknown>): void;
      check(): void;
      shutdown(): void;
    };
  }
}

// Usage
Cueflow.init({
  id: user.id,
  email: user.email,
  plan: user.subscription.plan
});

Error Handling

The script handles errors gracefully and logs warnings to the console:

Warning	Cause
"Cueflow: Already initialized"	init() called more than once
"Cueflow: user.id is required"	Missing id property
"Cueflow: workspace-id not found"	Missing data-workspace-id on script tag

Next Steps

• Cueflow.update() - Update user data after init

• Cueflow.track() - Track user events