Page tree
Skip to end of metadata
Go to start of metadata

Synchronous integration loads the Interaction Studio (formerly Evergage Classic) JavaScript beacon before continuing the rest of the page load, so Interaction Studio can prevent page flicker, a momentary flash of the original page content

Asynchronous integration loads the beacon (evergage.min.js) after the page has loaded. With this integration, Interaction Studio cannot protect against flicker.

The hybrid beacon integration is no longer supported by Interaction Studio.

Interaction Studio Classic Only

  • The contents of this article are intended for customers using Interaction Studio (formerly Evergage Classic).
  • The Visual Editor Chrome Extension will no longer be available starting January 1, 2023. For more information, see this knowledge article.
This Article Explains

This article details the two types of integration methods for use when personalizing parts of the page.

Sections in this Article


Synchronous (Recommended)

Asynchronous

SummaryThe Web SDK loads completely before the page’s contents load. This method of deployment is highly recommended for the best user experience.The Web SDK begins loading at the point it appears in the HTML, the page’s contents will continue loading / rendering while the Web SDK loads.
Pros
  • Interaction Studio can track data and deploy personalized campaigns as early as possible within the browser page lifecycle.
  • Compatible with ZeroFlicker which prevents content from popping into view and then flickering as personalized content replaces the default content on the page. Instead, the first visible content is already personalized.
  • Typically a simpler integration that can be done using a tag manager, such as Google Tag Manager or Tealium. If you plan to use a tag 
Cons
  • Delays page rendering by the amount of time required to load the Web SDK on the first page viewed. The impact is minimized by:
    • Keeping the data size of the Web SDK small
    • Delivering using a global Content Delivery Network (CDN) 
    • Utilizing client side caching
  • Poor user experience caused by campaign “flicker.” Flicker occurs when content appears on the page, then rapidly changes (flickering) as content is replaced after the initial page load with personalization by the Web SDK.
  • Delayed tracking and personalization. This delay can become more noticeable depending on the site and complexity of the page and other loaded libraries. It may result in missed page tracking as visitors navigate away quickly.

Recommendations

Interaction Studio recommends using the synchronous integration method when personalizing important parts of the page for several reasons:

  • It can be used with the Interaction Studio ZeroFlicker™ technology to prevent a negative experience for visitors when they see original content before it is replaced (flicker). Without ZeroFlicker™ and with an asynchronous integration, viewers may experience the original page content before Interaction Studio can replace it
  • Interaction Studio will load sooner, so personalization campaigns run faster on each page (recommended placement for the beacon in a synchronous integration is the header of the site)
  • Interaction Studio utilizes timeouts and a global Content Delivery Network (CDN) to speed this solution and minimize the potential of negative impacts. Since the Interaction Studio beacon is served directly from our CDN and not from our servers, even if our servers go down the Interaction Studio beacon will still load

However, if you plan to use a tag management system (like Google Tag Manager or Tealium), you will need to use the asynchronous integration which loads the Interaction Studio tracking beacon after the page content is loaded and rendered. While this guarantees negligible performance impact, it removes the option to utilize ZeroFlicker™ technology to alter page content without flicker effects. This may be acceptable in cases where personalizations are below the fold or not visible as the page loads.

Requirements

The synchronous style integration is only supported for customers running version 4 or later of the Interaction Studio JavaScript beacon. To adjust your beacon version:

  1. Log into your Interaction Studio account as an administrator
  2. Select SETTINGS
  3. In the Integration section at the left, select Beacon Version
  4. For details on each version of the beacon, please refer to the Change or Disable the Interaction Studio Classic JavaScript Beacon article