How does session replay work if there is an iFrame on the page?

 
 

Session replay is supported for websites that use iframes. Please see the tables below to find your specific use case and what's captured. For more details, see our guide to installing heap within an iframe.

Note that all iframe setups require you to enable secure cookies. Navigate to Manage Account Privacy & Security and scroll down to the Cookies section to toggle on Secure Cookies. Alternatively, you can enable secure cookies in your website’s code using the secureCookie JavaScript snippet.

Safari will block cookies if they are set in an iframe. This will prevent Heap from capturing the content of your iFrame

iframe scenarios

Outer page and inner iframe are on different domains

You want to… Supported? How to implement
capture both the outer page and the inner iframe, with the same Heap script Yes Heap must be installed on both the outer page and the inner iframe.

The events on the outer page and inner iframe will be stitched in the same session replay.
capture the inner iframe only (block the outer page) Yes Heap must be installed on the inner iframe. You must set the following parameter before Heap loads:

window._auryc_is_inner_frame_ = true;
capture both the outer page and the inner iframe, but with different Heap scripts Yes Heap must be installed on both the outer page and the inner iframe. You must set the following parameter before Heap loads:

window._auryc_is_inner_frame_ = true;

The events on the outer page and inner iframe will be associated with different session replays in different Heap environments.
capture the outer page only (block the inner iframe) Yes If Heap is already installed on the inner iframe, the inner iframe URL must be added to your list of blocked URLs. Otherwise, don't install Heap on the inner iframe.

Outer page and inner iframe are on the same domain

You want to… Supported? How to implement
capture both the outer page and the inner iframe Yes Heap must be installed on both the outer page and the inner iframe.
capture the outer page only (block the inner iframe) No N/A
Last updated