Skip to main content

Replay

See an example config here.

Available Options

OptionDescriptionDefaultType
recording.autoStartDetermines if replay will immediately begin collecting data. If false, you can resume collecting replay data using pendo.recording.start().trueboolean
recording.enabledDetermines whether or not replay is enabled.trueboolean
recording.onRecordingStartA function that gets called when replay starts collecting data.undefinedfunction
recording.onRecordingStopA function that gets called when replay stops collecting data.undefinedfunction
recording.treatIframeAsRootOption to treat this iframe as the root recording frame. When set to true, this iframe will emit its own recording events and create its own recording session, acting as a root recording frame. When set to false or undefined (default), recording events from this iframe will be passed up to the parent frame for handling.undefinedboolean
recording.workerUrlUsed when self hosting the replay web worker. Specifies the URL that points to the self hosted web worker.undefinedstring