Pendo Events

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

Event	Description
load	Emitted every time that Pendo detects a url change. This can be through page loads, url customization, or page event properties
identify	Emitted whenever a non-anonymous visitor id is used when initializing/updating a visitor or when the account id changes
meta	Emitted whenever the metadata for a visitor changes, including ids and visitor or account fields.
track	Emitted 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.

Event	Description
guideSeen	Emitted every time a Guide Step is presented
guideAdvanced	Emitted every time a Guide Step is advanced by a button action or via onGuideAdvanced
guideDismissed	Emitted every time a Guide Step is dismissed by a button action or via onGuideDismissed
guideSnoozed	Emitted every time a Guide Step is snoozed by a button action or via onGuideSnoozed
guideActivity	Emitted every time a button within a Guide Step is clicked
guideTimeout	Emitted after an attempt to display a Guide Step and the step doesn't show
guideSnoozeCanceled	Emitted when a guide that was previously snoozed is shown for any reason (i.e. shown by badge click)
guideNotSeen	Emitted when a guide would have been seen but the visitor was in the control group for the guide
pollResponse	Emitted 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 pendo.events methods or by specifying handlers in pendo.initialize(options)

Handlers
ready	Triggered when the agent is loaded and initialized, i.e. isReady would return true.
guidesLoaded	Triggered when guides have loaded successfully, including any associated content assets. Only triggers if at least one guide is returned for the visitor.
guidesFailed	Triggered 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.
deliverablesLoaded	Triggered when the request to load guides has finished but before any associated content. Will trigger even if no guides are returned.
validateGuide	Triggered whenever content for an individual guide or resource center is requested. Throwing an error in the handler prevents the guide from showing.
validateLauncher	Triggered whenever the launcher for classic guides is going to display. Throwing an error in the handler prevents the guide from showing.
validateGlobalScript	Triggered 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

pendo.events
    .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
    });

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