capabilities.work

Browser Session Lifecycle

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

Recipe · 3 steps

Browser Session Lifecycle

with Highlight (highlight.io)

Open a Highlight session, identify the user, and push the first recording payload.

  1. Run the initializeSession GraphQL mutation to open a new session for the project and return its session_secure_id.
  2. Run the identifySession GraphQL mutation to attach a user identity and property map to the session opened above.
  3. Run the pushPayload GraphQL mutation to upload the first batch of recorded events, console messages, and frontend errors for the session.
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 the session was recorded in.
  • appVersion: The application version under which the session was recorded.
  • clientId: A stable client identifier for the browser.
  • userIdentifier: The user identifier to attach to the session (e.g. an email).
  • userObject: Arbitrary user property map attached during identify.
  • events: The rrweb events object for the first pushPayload batch.
  • messages: Serialized console/network messages for the first pushPayload batch.
  • errors: Frontend errors captured in the first pushPayload batch.
For your developer

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

More recipes with Highlight (highlight.io)

Backend Error ReportBackend Session PayloadCorrelated Backend Telemetry ExportFrontend Error CaptureFullstack Error CorrelationFullstack Session CorrelationLogs and Metrics BatchSession Feedback CaptureSession Track Event