Configuration

The Pendo Agent is built with your application's configuration settings included into it. However, there are many settings you can change when you initialize the Agent. This allows you to have different configurations based on application state and have more fine grained control. All configuration options are provided to the Agent in the pendo.initialize call immediately after your install snippet. The initialize method and a few others are stubbed in the snippet so that the Agent will run queued invocations when it becomes ready.

Example

pendo.initialize({
    apiKey: 'YOUR_API_KEY',
    visitor: {
        id: <visitor-id-goes-here>, // Required if user is logged in
        // full_name: "John Doe",   // Recommended if using Pendo Feedback
        // email: "user@acme.com",  // Recommended if using Pendo Feedback or NPS email
        // role: "Viewer"           // Optional

        // You can add any additional visitor level key-values here,
        // as long as it's not one of the above reserved names.
    },
    account: {
        id: <account-id-goes-here>, // Recommended, required if using Pendo Feedback
        // name: "Acme Co",         // Optional
        // is_paying: false,        // Recommended if using Pendo Feedback,
        // monthly_value: 0,        // Recommended if using Pendo Feedback

        // You can add any additional account level key-values here,
        // as long as it's not one of the above reserved names.
    },
    allowedText: [],
    analytics: {
        excludeEvents: []
    },
    disableCookies: true,
    excludeAllText: true,
    guideSeenTimeoutLength: 10000,
    guides: {
        delay: false,
        disabled: false,
        globalScripts: [
            {
                script: function(step, guide) {
                    console.log('Step ', step.id, ' has run');
                }
            }
        ],
        timeout: 30000
    },
    recording: {
        autoStart: true
        enabled: true
    }
});