Overview

The API call is JavaScript code that launches a lightbox. A lightbox displayed in this manner circumvents all rules and conditions. However, because every lightbox is required to have at least one condition set in order to be eligible for display, an API triggered lightbox must have a condition in order for it to be shown on a web page.

The criteria in the condition rule does not have to evaluate to true. For example, a condition rule such as "current page url = abc" will never be true, but it will make the lightbox eligible for display and it will be possible to trigger the lightbox via the API. While a lightbox triggered via an API call requires a condition to be set in order to be eligible for display, the logic that that determines how and when the lightbox is displayed is entirely set in the Custom JS.

API call

The following Web Forms API call will launch a lightbox.

api.LIGHTBOX.loadLightbox([GUID]);

This code should be placed in Custom JS (Parent).

The GUID value for a lighbox can be found by clicking on the ID of a lightbox.