Highlight

The Highlight Developer Hub

Welcome to the Highlight developer hub. You'll find comprehensive guides and documentation to help you start working with Highlight as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Identifying Users

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

Usage is as follows:

// remember to wrap this method in `if (typeof window !== 'undefined')` in next.js

H.identify(
    "[email protected]", 
    {id: "ajdf837dj", phone: "867-5309"}
)

Updated 2 months ago


What's Next

Tracking Events

Identifying Users


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.