Last updated

Link Navigation Request Message

Overview

The Link Navigation Request message is sent only when a partner specifies overrideLinkNavigation as true on their launcher (see Integration Launcher Options). Once this has been opted in you will receive a LINK_NAVIGATION_REQUEST message on subscribing to a Selection or a Placement.

For example, after opting into overrideLinkNavigation on the launcher, you can subscribe with the following code to receive events each time a user clicks on a link to navigate to another page.

// Rokt script already loaded

const selection = await launcher.selectPlacements({
  attributes: {
    // attributes required by Rokt to retrieve the catalog items
    eventId: "eventId",
    venueName: "venueName",
    // any additional attributes
    email: "email",
  },
});

selection.on("LINK_NAVIGATION_REQUEST").subscribe((event) => {
  // Handle the navigation request using the url property
  window.open(event.body.url);
});

Properties

url

• url: string

If a customer clicks on an offer link when overrideLinkNavigation is enabled, they will not automatically open a new browsing tab. Instead the Rokt SDK will send an event containing the url as a string that needs to be handled by the partner. This url should be immediately opened in the browsing context required (web view or native browser as agreed), to avoid any degration to the customer experience.