This method is used to add an identity to a user for the session. You can learn more Identifying Users.

H.identify(identifier: string, metadata?: [key: string]: string | boolean | number) => void;

identifier Required

The identifier for the user in the session. This is often an email or UUID.

metadata

Metadata for the user. You can think of these as additional tags for the user. If the highlightDisplayName or email fields are set, they will be used instead of identifier as the user's display name on the session viewer and session feed.

Example

H.identify('alice@corp.com', {
	highlightDisplayName: 'Alice Customer',
	accountType: 'premium',
	hasUsedFeature: true,
})