Skip to main content

Pendo Events

The Agent sends various virtual events for actions that occur to identify various aspects of product usage.

loadEmitted every time that Pendo detects a url change. This can be through page loads, url customization, or page event properties
identifyEmitted whenever a non-anonymous visitor id is used when initializing/updating a visitor or when the account id changes
metaEmitted whenever the metadata for a visitor changes, including ids and visitor or account fields.
trackEmitted whenever the agent function pendo.track is called and passes along the provided information

Guide Events

The Guide sub-system tracks user interactions with displayed Guides through a series of Guide Events transmitted to Pendo whenever a Guide is presented or otherwise interacted with.

guideSeenEmitted every time a Guide Step is presented
guideAdvancedEmitted every time a Guide Step is advanced by a button action or via onGuideAdvanced
guideDismissedEmitted every time a Guide Step is dismissed by a button action or via onGuideDismissed
guideSnoozedEmitted every time a Guide Step is snoozed by a button action or via onGuideSnoozed
guideActivityEmitted every time a button within a Guide Step is clicked
guideTimeoutEmitted after an attempt to display a Guide Step and the step doesn't show
guideSnoozeCanceledEmitted when a guide that was previously snoozed is shown for any reason (i.e. shown by badge click)
guideNotSeenEmitted when a guide would have been seen but the visitor was in the control group for the guide
pollResponseEmitted when the visitor responds to an in-Guide poll question

See Guide Runtime to learn about the extended guide event system and to customize guide activity.

Event System

The Agent implements a simple event emitter pattern for specific synthetic events that customer applications might be interested in. Your application can register handlers for these events via the methods or by specifying handlers in pendo.initialize(options)

readyTriggered when the agent is loaded and initialized, i.e. isReady would return true.
guidesLoadedTriggered when guides have loaded successfully, including any associated content assets. Only triggers if at least one guide is returned for the visitor.
guidesFailedTriggered when guides fail to load because of a network error or timeout, when guideTimeout or guides.timeout is set to a numeric value in milliseconds.
deliverablesLoadedTriggered when the request to load guides has finished but before any associated content. Will trigger even if no guides are returned.
validateGuideTriggered whenever content for an individual guide or resource center is requested. Throwing an error in the handler prevents the guide from showing.
validateLauncherTriggered whenever the launcher for classic guides is going to display. Throwing an error in the handler prevents the guide from showing.
validateGlobalScriptTriggered when the global guide script is downloaded or a new global script for guides is added programmatically (like for guide markdown). Returning a falsy value prevents the script from being added.

Event Example
.ready(function() {
// Do something once `pendo.isReady()` would return `true`
.guidesLoaded(function() {
// Do something when Guides load
.guidesFailed(function() {
// Do something when Guides fail to load

apiKey: 'YOUR_API_KEY',
visitor: { /* visitor `id` and metadata */ },
account: { /* account `id` and metadata */ },
events: {
ready: function () {
// Do something when pendo is initialized