Set User Identity & Properties
Identify Users Reliably with setUserIdentity
setUserIdentityUXCam gives every fresh install a random alias name based on unique Install ID.
That works... until issues arise, such as when the same person re-installs the app, shares a device with another user, or signs into their account on multiple devices (which creates a different Install ID for each).
Fix: call UXCam.setUserIdentity()once per session as soon as the real user is known (login, sign‑up, deep‑link token, silent auth).
When to call setUserIdentity
setUserIdentity| Trigger | Why it works |
|---|---|
| Immediately after successful login / sign‑up | Backend‑verified identifier—safe to map to the Install ID. |
| Every app launch (recommended, idempotent) | Catches silent or SSO (Single Sign-On) logins and reinstalls; the call is debounced to prevent unnecessary repeated calls. |
Note
One call per session is sufficient. Once UXCam links an Install ID to a User ID, the value persists, and subsequent calls with the same ID are ignored.
Code snippet
// After the auth flow succeeds
String uid = authResult.getUserId(); // e.g. "user_42"
UXCam.setUserIdentity(uid);UXCam.setUserIdentity(authResult.userId)Enrich Users with Custom Properties
Attach up to 100 key–value pairs per user to segment funnels and heat‑maps by plan, cohort, geography, and more.
UXCam.setUserProperty("plan", "pro");
UXCam.setUserProperty("signup_source", "google_ads");
UXCam.setUserProperty("nps_score", "9"); // Cast numbers to strings| Best-practice | Why |
|---|---|
| Use stable, non‑PII IDs / enums | Avoid GDPR headaches; you can always map to an email in your own DB. |
| Prefer snake_case keys | Prevents duplicates (planType vs plan_type). |
| Update only when a value changes | The SDK overwrites the previous value—no need to resend unchanged props. |
Need to send PII (e.g. email)? Sign a DPA with UXCam first: [email protected].
Verify Your Work
- Log in with a test account on a debug build.
- Wait for the session to upload.
- In the Dashboard, open Users → Search and enter the test User ID.
- You should see one merged user with sessions from all devices and reinstalls.
If the user is missing:
- Check Logcat for
UXCam: setUserIdentity called with .... - Ensure the call runs after the SDK has been initialized with
UXCam.startWithConfiguration(). - Confirm the ID is non‑null & non‑empty (empty strings are ignored).
Troubleshooting Cheat‑Sheet
| Issue | Likely cause | Fix |
|---|---|---|
| Two records for the same user | Different casing (User42 vs user42) | Convert IDs to lower‑case before sending. |
| User disappears after reinstall | setUserIdentity only called on first install | Also call it on every app launch or after silent token refresh. |
| Property not visible | Sent as int; dashboard expects strings | Cast all numeric values to strings. |
QA Checklist
UXCam.setUserIdentity()is called once per session after authentication.- Key properties (
plan,signup_source, …) appear under user properties. - No PII stored unless a DPA is in place.
- Re-installing the app and logging in links the new session to the correct user.
Updated 5 months ago