Identifying Users and Creating a User (For Automation Service)

After initializing the SDK, call authorizeUser to identify the user currently interacting with your website. This associates subsequent SDK data with that user and creates or retrieves the user in Metrix User Lookup.

import { authorizeUser, init } from '@metrixorg/websdk';
 
init('APP_ID', 'API_KEY');
authorizeUser('CUSTOM_USER_ID');

authorizeUser(username: string): void

Call authorizeUser after init and before sending user or event data that should belong to the identified user. The SDK uses the identifier to associate data with the user; it does not need to be a display name.

To return the SDK to an anonymous state during logout, call:

import { deauthorizeUser } from '@metrixorg/websdk';
 
deauthorizeUser();

deauthorizeUser clears the current user identity and stored user profile data from the SDK.

Updating User Information

After calling authorizeUser, use the following methods to update the user profile in Metrix User Lookup. Each setter accepts an optional callback that runs after the update succeeds.

setFirstName(firstName: string) : void

setLastName(lastName: string) : void

setEmail(email: string) : void

setHashedEmail(hashedEmail: string) : void

setPhoneNumber(phoneNumber: string) : void

setHashedPhoneNumber(hashedPhoneNumber: string) : void

setCountry(country: string) : void

setCity(city: string) : void

setRegion(region: string) : void

setLocality(locality: string) : void

setGender(gender: string) : void

setBirthday(birthday: string) : void

setCustomAttribute(key: string, value: string) : void

Example:

import {
  setFirstName,
  setEmail,
  setGender,
  setBirthday,
  setCustomAttribute,
} from '@metrixorg/websdk';
 
setFirstName('Ali');
setEmail('ali@example.com');
setGender('male');
setBirthday(Date.parse('1990-05-20'));
setCustomAttribute('plan', 'premium');

Use setHashedEmail and setHashedPhoneNumber when your integration requires hashed contact data. Do not send sensitive values as custom attributes unless your data policy allows it.

setFcmToken stores an FCM token for integrations that use Firebase Cloud Messaging. Web push subscriptions are configured separately through the Web Push API.

Retrieving User IDs

Metrix generates a metrixUserId and, for identified users, an automationUserId. Both values are available through promises after the corresponding user has been created on Metrix servers.

Metrix user ID

import { onMetrixUserIdReceived } from '@metrixorg/websdk';
 
onMetrixUserIdReceived().then((metrixUserId: string) => {
  console.log(metrixUserId);
});

Automation user ID

import { onAutomationUserIdReceived } from '@metrixorg/websdk';
 
authorizeUser('CUSTOM_USER_ID');
 
onAutomationUserIdReceived().then((automationUserId: string) => {
  console.log(automationUserId);
});

onMetrixUserIdReceived(): Promise<string>
onAutomationUserIdReceived(): Promise<string>

These promises remain pending until the SDK receives the ID. In most cases, you do not need to retrieve or store either ID unless another integration requires it.

API Summary