Replay
See an example config here.
Available Options
| Option | Description | Default | Type |
|---|---|---|---|
recording.autoStart | Determines if replay will immediately begin collecting data. If false, you can resume collecting replay data using pendo.recording.start(). | true | boolean |
recording.enabled | Determines whether or not replay is enabled. | true | boolean |
recording.onRecordingStart | A function that gets called when replay starts collecting data. | undefined | function |
recording.onRecordingStop | A function that gets called when replay stops collecting data. | undefined | function |
recording.recordCrossOriginIframes | Controls whether content embedded from another domain is included in replay. When enabled, the embedded content shows up as part of the page. When disabled, it appears as a blank box. This only applies to embedded content that also has Pendo installed. Embeds from other companies (Stripe, YouTube) are never captured either way — turning this off just stops Pendo from messaging those frames at all. To capture embedded content as its own separate replay instead of part of the page it sits in, see recording.treatIframeAsRoot. | true | boolean |
recording.treatIframeAsRoot | Option 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. | undefined | boolean |
recording.workerUrl | Used when self-hosting the replay web worker. Specifies the URL that points to the self-hosted web worker. | undefined | string |