Star us on GitHub

Identifying Users

To tag sessions with user-specific identifiers (name, email, etc.), you can call the H.identify()method in your app. This will automatically index your sessions so that they can be filtered by these attributes.

H.identify('', { id: 'ajdf837dj', phone: '867-5309' })
User Display Names

By default, Highlight will show the identifier as the user's display name on the session viewer and session feed. You can override this by setting the highlightDisplayName or email fields in the H.identify() metadata.

Customer User Avatars

You can replace the placeholder user avatars Highlight uses with an image that you provide. You can do this by setting the avatar field in the H.identify() metadata.

The image URL usually comes from your authentication provider (Firebase, Auth0, Active Directory, etc.). You can forward that URL to Highlight.

Saving the image

Highlight does not make a copy of the image. Highlight will render the image directly. This means the image will adhere to any authorization policies.

H.identify('', { avatar: 'https://<IMAGE_URL>.png' })

See the H.identify() API documentation for more information on how to use it.

What happens before a user is identified?

All key session information is tracked regardless of whether a session is identified. Highlight will generate an identifier for a user which you can see in the session player unless you set your own by calling H.identify().

When a user is identified we will attempt to assign their information to previous sessions from the same browser. If this happens you will see an indicator in the UI showing the data was inferred for a session and that the session was never explicitly identified.