Event listener

Every event the pagent SDK records is also dispatched on window as a pagent:event CustomEvent. Listen to it to debug your tracking or to forward pagent data to your own tools.

To send test assignments and conversions to Google Tag Manager, JENTIS or another dataLayer, you don’t need a listener. Turn on tag manager forwarding instead.

This page is about reading what pagent records. To send your own events to pagent, see Sending events. Here is an example:

<script>
  window.addEventListener('pagent:event', (e) => {
      console.log("pagent:event", e.detail);
  });
</script>

Note: If no session is active, pagent will not emit any events on the pagent:event bus.

Event types

Below is an overview of all event kinds that pagent emits.

Event `kind`	Description
click	Fired whenever the visitor clicks anywhere on the page.
page_view	Fired each time a page is loaded or navigated to.
opt_in	Fired when the visitor explicitly opts-in to tracking.
opt_out	Fired when the visitor opts-out of tracking.
event	Fired when an event is recorded, whether your code reported it or pagent observed it.
conversion	Fired when the SDK records a conversion in the browser: a click goal, a page view goal, or a deprecated programmatic conversion. Event goals are computed later and do not fire this.
session_start	Fired the moment a new session begins.
session_end	Fired when the current session is terminated.
error	Fired whenever an error occurs while running pagent.
highlight_text	Fired when pagent highlights text on the page.
element_view	Fired when a tracked element scrolls into the viewport.
hover	Fired when the visitor hovers over a tracked element.
session_ping	Sent periodically while a session is active to keep it alive.

Common properties

The following attributes are included in every event:

Property	Type	Description
session_id	string	Unique identifier of the current session.
visit_id	string	Unique identifier of the current page view.
time	number	Unix timestamp in milliseconds when the event occurred.
is_unique	boolean (optional)	`true` if this is the first time this event type was emitted during the session.
is_opted_in	boolean	Indicates whether the visitor has opted-in to tracking.
session_duration	number	Session duration in milliseconds at the moment the event was emitted.
scroll_depth	number	Maximum vertical scroll position in pixels that the visitor has reached so far.
scroll_percentage	number	Percentage of the page that has been scrolled.
url	string	Absolute URL of the page where the event happened.

event properties

Events of kind event carry these properties alongside the common ones:

Property	Type	Description
label	string	The event label, for example `purchase`.
source	string (optional)	How the SDK captured it: `reported` (or absent) for `window._pgnt.push`, `data_layer`, `window_event` or `trigger` for observed events.
revenue	number (optional)	Revenue in cents.
properties	object or array (optional)	The event’s properties.

session_start properties

The session_start event is the one that carries the visitor’s experiment context. When the visitor is enrolled in a running test, it includes the following additional properties (alongside the common properties above):

Property	Type	Description
experiment_id	string (optional)	The experiment UUID.
experiment_numeric_id	number (optional)	The sequential test number shown in the pagent dashboard as “Test #N” (for example, `27`). Useful for building human-readable names.
variation_id	string (optional)	UUID of the variation assigned to this visitor.
is_control	boolean (optional)	`true` if the visitor is in the control group, `false` if in a variant.
endpoint_id	string (optional)	UUID of the targeted endpoint.
endpoint_path	string (optional)	The path the test is configured to target, for example `/pricing`. For tests targeting a URL pattern (glob), this may be the pattern rather than the exact visited URL.
cohort_id	string (optional)	UUID of the cohort the visitor belongs to.
cohort_version	number (optional)	Version of the cohort definition.

Note: All of these experiment fields are absent (or null) when there is no active pagent test on the current page, for example analytics-only sessions or visitors not enrolled in any running test. Always check event.experiment_id before reading the others, as the JENTIS example below does.

Example integration

You can also forward individual pagent events to other analytics platforms by hand. The example below sends the conversion event to JENTIS using its push-based data layer. For JENTIS itself, tag manager forwarding now does this without code; use the example as a pattern for other tools.

<script>
  // Keep track of the current session
  let session = null;

  // Forward pagent "conversion" events to the JENTIS data layer
  window.addEventListener('pagent:event', (e) => {
    const event = e.detail;

    // Store the session start event in case we are running an experiment
    if (event.kind === 'session_start' && event.experiment_id) {
      session = event;
      return;
    }

    // Only track conversions for active experiments
    if (!session || event.kind !== "conversion") return;

    // Prepare the JENTIS queue (it as a simple array on window)
    window._jts = window._jts || [];

    // Push the event object itself
    _jts.push({
      track: 'event', // JENTIS track command
      group: 'generic', // optional grouping
      context: 'pagent', // helps to identify the source
      kind: 'conversion', // helps to identify the event type
      experiment_id: session.experiment_id, // unique identifier of the experiment
      variation_id: session.variation_id, // unique identifier of the variation
      cohort_id: session.cohort_id, // unique identifier of the cohort
      is_control: session.is_control // whether the displayed variation is control
    });

    // Finally submit everything to JENTIS
    _jts.push({ track: 'submit' });
  });
</script>

This keeps your implementation lightweight. You only need to listen for pagent events and decide which ones you want to forward. The example above listens exclusively for the conversion event and immediately submits it to JENTIS. To forward your own events as well, also match event.kind === "event" and pass event.label along.

Getting started

AI clients

Integration

Tracking

FAQ

Event types

Common properties

event properties

session_start properties

Example integration

​Event types

​Common properties

​event properties

​session_start properties

​Example integration

Event types

Common properties

event properties

session_start properties

Example integration