Clix Documentation

You can check how to use the API in the Clix SDK GitHub repositories for each platform:

For additional conceptual details, see the Clix Documentation on User.

If no user ID is set, Clix will automatically treat the user as anonymous with only a device ID and an auto-generated project-user-id.

If a user ID is set, the anonymous user will be converted into an Identified User, linking all their previous activity with their account.

When to Use User Management

Anonymous user (default)

By default, when your app starts without setting a user ID, Clix assigns an anonymous profile. This is useful when users are browsing your app without logging in.

Identified user (after login/signup)

Once a user logs in or creates an account, you can call the User Management API to assign a permanent userId. This converts the anonymous user to an Identified User, ensuring continuity of notifications, preferences, and analytics across devices.

User logout

When a user logs out, you don’t need to take any action. Events after logout are attributed to the last known user. Call reset() only if you need to fully anonymize the user (e.g., shared devices).

User Logout / Reset

By default, you don’t need to handle logout explicitly. Events sent after logout are attributed to the last known user, which is sufficient for most use cases. If you need to explicitly log users out or track events under an anonymous user (e.g., shared devices where multiple people sign in), call reset(). This anonymizes the user by:

Setting the user ID to null
Clearing the device ID so a new one is generated on next initialization

With an empty user ID and a completely new device ID, the current user appears as a brand new anonymous user in the dashboard. After calling reset(), you must call initialize() again before using the SDK.

// On logout
Clix.reset()

// On next login
Clix.initialize(config: config)
Clix.setUserId("user_12345")

// On logout
Clix.reset()

// On next login
Clix.initialize(context, config)
Clix.setUserId("user_12345")

// On logout
await Clix.reset();

// On next login
await Clix.initialize({ projectId: "...", apiKey: "..." });
await Clix.setUserId("user_12345");

// On logout
await Clix.reset();

// On next login
await Clix.initialize(ClixConfig(projectId: "...", apiKey: "..."));
await Clix.setUserId("user_12345");

removeUserId() is deprecated. Use reset() instead.

Example Usage

// 1. Anonymous user (default)
// No userId is set, Clix generates a project-user-id internally

// 2. Identified user
// After login, set a unique userId
Clix.setUserId("clix_user")

Setting User Properties

You can attach custom properties to a user profile for personalization and analytics. Properties can be strings, numbers, or booleans. Set a single property (async):

try await Clix.setUserProperty("subscription", value: "premium")

Set multiple properties (async):

try await Clix.setUserProperties([
  "age": 25,
  "city": "Seoul",
  "premium": true
])

Set a single property (sync):

Clix.setUserProperty("subscription", value: "premium")

Set multiple properties (sync):

Clix.setUserProperties([
  "age": 25,
  "city": "Seoul",
  "premium": true
])

Removing User Properties

You can remove one or more properties from a user profile. Remove a single property (async):

try await Clix.removeUserProperty("subscription")

Remove multiple properties (async):

try await Clix.removeUserProperties(["age", "premium"])

Remove a single property (sync):

Clix.removeUserProperty("subscription")

Remove multiple properties (sync):

Clix.removeUserProperties(["age", "premium"])

Error Handling

All user management operations can throw errors. Always handle errors for robust apps: Error handling example:

do {
  try await Clix.setUserId("user123")
} catch {
  print("Failed to set user ID: \(error)")
}

​When to Use User Management

​User Logout / Reset

​Example Usage

​Setting User Properties

​Removing User Properties

​Error Handling

When to Use User Management

User Logout / Reset

Example Usage

Setting User Properties

Removing User Properties

Error Handling