capabilities.work

Session Track Event

A 3-step recipe with Highlight (highlight.io). We can help you get access.

Recipe · 3 steps

Session Track Event

Initialize a session, record a track event, and flush its recording payload.

  1. Run the initializeSession GraphQL mutation to open a session and return its session_secure_id.
  2. Run the addTrackProperties GraphQL mutation to record a named track event and its property map against the session.
  3. Run the pushPayload GraphQL mutation to flush the recorded events so the track event lands on the session timeline.
What you'll need to have ready
  • organizationVerboseId: The Highlight project verbose id that owns the session.
  • clientVersion: The highlight.run client SDK version.
  • firstloadVersion: The firstload script version.
  • environment: The deployment environment.
  • clientId: A stable client identifier for the browser.
  • trackProperties: The track event property map (should include the event name and its attributes).
  • events: The rrweb events object flushed with the final payload.
  • messages: Serialized console/network messages flushed with the final payload.
For your developer

Arazzo workflow highlight-io:session-track-event, 3 operations: executePublicGraphMutation → executePublicGraphMutation → executePublicGraphMutation. Specs on APIs.io.