home

Zephr

Zuora BillingZuora PaymentsZuora PlatformZuora CPQZephrZuora RevenueAccounts ReceivableRelease NotesBasicsEntitlementsSupport and policies
Zuora BillingZuora PaymentsZuora PlatformZuora CPQZephrZuora RevenueAccounts ReceivableRelease NotesBasicsEntitlementsSupport and policies

Welcome to Zuora Product Documentation

Explore our rich library of product information

Show Contents

thumbnailZephr

Data tracking deployment

Properties

Provides a comprehensive reference for Scroll Tracking payload properties, detailing the required variables and values for event tracking in AI Paywall.

This page provides a detailed reference for the Scroll Tracking payload properties used when tracking user scroll behavior. The information is relevant to both client-side and server-side implementations and can help ensure consistency and accuracy when sending scroll data to Zephr.

The following table outlines the required variables and their corresponding values for event tracking in AI Paywall:

VariableDescription

brandId

(required for client-side)

A unique brand identifier dynamically populated by JavaScript.

wId_2

(required)

An offer ID or rate plan array passed by the client.

dtId

(required)

The blaize_tracking_id value.

For client-side implementations, this ID is automatically populated by the Zephr JavaScript.

For server-side implementations, it must be retrieved manually from the Zephr cookie of the same name.

action

(required)

A unique identifier indicating the action taken.

isAttr(optional, specific to conversion events)

If true, the conversion did not originate from a CTA on a Zephr component, for example, site navigation or external links.

refer

(required)

The document.referrer value passed by the client.

requestUrl

(required)

The current page URL. Use window.location.href for this value.

actionValue

(required for scroll tracking and conversion events

  • For conversion events, specify the value in cents. For example, 3900 represents 39.00 USD. This field accepts any currency in a cents-based format.

  • For scroll tracking events, specify the scroll depth percentage. Supported values are 30, 60, and 90.

user object

Context about the viewed content.

  • userState (required) - Defines user type; accepted values are anonymous, registered, subscribed. (Automatically handled by JavaScript for client-side; for server-side, populate manually using this guide.

  • userID (required) - Unique user ID assigned to the visitor. This is required when userState = registered, empty if anonymous.

  • knownDate (optional) - Date when the user was first identified.

  • isTrial (optional) - True if the user is currently assigned to a trial product.

  • isLapsed (optional) - True if the user's subscription has expired and not renewed.

content object

Context about the type of content.

  • increaseRA (required) - If true, counts the page view towards the meter; if false, tracks the view without including it in the meter count.

  • articleId (required) - Unique ID for the article. if article ID is not available then requestURL can be used as a value. articleId must be populated if increaseRA is true.

  • section (optional) - Content section or category of the page.

  • subSection - Additional information about the page.

  • articleType - Article template or content type.

  • articleClass - Classifies the article, for example, metered, blocked, or displays other relevant information about the role of the article.

product object

Context passed by the client about the type of paywall.

  • offerName (optional) - Offer description.

  • offerKey (optional) - Any other key or ID you wish to pass for the offer being shown

  • product_sku (optional) - A unique identifier (SKU) assigned to the product for tracking and inventory purposes.

  • product_name (optional) - The name of the product as displayed to use.

  • product_subscription_interval (optional) - Subscription billing interval (e.g., monthly, yearly) to define the billing frequency.

context object

Context about the user's journey.

  • countryCode (optional) - 3-letter country code, following ISO 3166-1 alpha-3 standard (retrieved from browser if not supplied).

  • userAgent (optional) - String that identifies the user's OS, device, and browser details. This can be retrieved from the browser if not supplied

  • referSource (optional) - Named referral source, if used in your tracking setup.

  • custom (optional) - Object containing any custom key-value pairs for additional AI Paywall data.

checkout object

Context about the checkout journey.

  • isAlt (optional) - True if the user switched to a different offer during checkout (e.g., upgrade or downgrade) than the one originally clicked on the paywall component.

  • isDropOff (optional) - True if the user started but did not complete checkout (i.e., abandoned before finalizing).

Last updated: March 30, 2026