Journey JavaScript SDK

Search the table of all articles in this guide, listed in alphabetical order, to find the article you need.

Article	Description
Article	Description
About Events methods	Events methods allow developers to build functionality that reacts to state changes in the SDK. Important This article only applies to customers using web chat. If you are a Genesys Cloud CX customer, we encourage you to use the new web messaging feature to replace web chat.
About modules	Learn about optional JavaScript files that enhance the functionality that the Journey JavaScript SDK provides.
About the tracking snippet	Learn what happens after you deploy the tracking snippet on your webpages.
Advanced tracking with cookies	Learn how to use the Journey JavaScript SDK to refine how Genesys Predictive Engagement tracks visitor data. Alternatively, you can refine tracking using your preferred tag manager. For more information, see About event tracking with tag managers.
api.session.getCustomerCookieId	Learn how to obtain a customer's cookie ID.
api.session.getData	Learn how to obtain the data such as the short ID for a particular customer's session.
api.session.getId	Learn how to get the Id of a particular session.
autotrackClick	Learn how to configure which click events Genesys Predictive Engagement tracks on your websites. This configuration provides more accurate page tracking information for use in segments and outcomes.
autotrackIdle	Learn how to configure when Genesys Predictive Engagement detects inactivity on a webpage. This configuration provides more accurate page tracking information for use in segments and outcomes.
autotrackInViewport	Learn how to configure which element Genesys Predictive Engagement tracks on your websites as they appear and disappear from the viewport. This configuration provides accurate page tracking information for use in segments and outcomes.
autotrackOfferStateChangesInAdobeAnalytics	Learn how to track web chat and content offer state changes on a webpage and send them to Adobe Analytics.
autotrackScrollDepth	Learn how to configure which scroll milestones Genesys Predictive Engagement tracks on your websites. This configuration provides more accurate page tracking information for use in segments and outcomes.
autotrackURLChange	Learn how to customize tracking for Single Page Application (SPA) websites. Alternatively, use your preferred tag manager to customize and deploy the SPA tracking snippet. For more information, see About event tracking with tag managers. If you are just getting started, read Predictive Engagement tracking snippet.
Content offers lifecycle	See the lifecycle of a content offer and the metrics that we capture at each state along the way. We use lifecycle states in reporting and when determining the triggering behavior of action maps that use content offers.
Cookies	Configure how Genesys Predictive Engagement uses cookies to store customer data.
customAttributes	Learn how to use custom attribute to send additional information about your web events.
debug	Learn how to send helpful messages to the console when you are troubleshooting tracking behavior.
destroy	Learn how to use the destroy method to stop all Journey JavaScript SDK activity and remove all tracking information.
Display icons in the Journey gadget	Learn how to use the SDK to display icons for tracked visitor behavior on the Journey map.
dom - ready	Learn how to specify a function handler to run when the DOM has loaded fully.
Examples: Events methods with content offers	See examples of how to use Events methods with content offers.
Examples: Events methods with web chats	See examples of how to use Events methods with web chats.
Exclude URL query parameters	Exclude irrelevant URL query parameters to improve analytics.
Form Tracking API	Learn how to use an API to track form submission and abandonment events, including what information visitors provide in your forms.
forms:track	Learn how to use theforms:track method to capture when visitors complete web-based forms.
Get started	Get started using the Journey JavaScript SDK.
identify	Learn how to use the identify method to add information to a customer record.
init	Learn how to use the init method to initialize the Journey JavaScript SDK.
Initialization methods	View the methods that initialize and destroy the Journey JavaScript SDK.
initialized	Learn how to use the initialized method to receive notification when the Journey JavaScript SDK has initialized fully.
load	Learn how to add the functionality of a module to the Journey JavaScript SDK.
Map traits to link customer records	Learn how to map multiple records for the same customer to see more complete customer profiles in Live Now.
Method reference	View a list of methods available in the Journey JavaScript SDK.
off	To unsubscribe from receiving notifications about a particular type of SDK activity, use ac('off').
on	To subscribe to receive notifications about a particular type of SDK activity, use ac('on').
once	To receive a notification for only the first SDK event for a particular type of activity, use ac('once').
pageview	Learn how to use the pageview method to track when visitors view your webpages.
record	Learn how to use the record method to capture website events.
serialize	Learn how to use the serialize method to submit serialized data from a form.
Session methods	View the methods that allow you to obtain data about a specific session.
Track a page's canonical URL	Track the canonical URL of a page for precise pageview counts.
Track the #hash portion of the URL fragment	Track the #hash portion of URL fragments to include relevant information in analytics.
Tracking methods	Learn about the methods available in the Journey JavaScript SDK that you can use to extend and enhance how Genesys Predictive Engagement tracks visitor activity on your website.
Types of tracked data	Learn how to track different types of data using Journey SDK.
Use Events methods with web actions	Use Events methods to subscribe to events that occur during the lifecycle of Genesys Predictive Engagement web actions such as web chats and content offers. This raw data can be streamed to third-party analytics platforms or to tag management platform data layers for use in analytics and reporting platforms.
Utility methods	Learn how to simplify calls to the Journey JavaScript SDK collection methods.
Web chat lifecycle	See the lifecycle of a web chat and the metrics that we capture at each state along the way. Genesys Predictive Engagement uses lifecycle states for reporting and determining the triggering behavior of action maps that use web chats.
Web Tracking API	Learn how to track visitor activity using an API.