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    

Tracking Events

You may want to search for all sessions with a specific event, for example, "User Clicked Checkout". To define these events in Highlight, you can use the H.track(event: string, object: Object) method. This method can be called in the lifetime of a session.

Usage is as follows:

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

H.track(
    "User Clicked Checkout", 
    {checkoutType: "early", store: "chicken"}
)

Updated 3 months ago

Tracking Events


Suggested Edits are limited on API Reference Pages

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