Functions

Boxever.callFlows(flow, callback)

The callFlows() function runs an Interactive Full Stack Experience or an Interactive Full Stack Experiment that is currently live in Sitecore Personalize. You must call this function with the friendlyId of the live experience or experiment that you want to run.

Note

Call this function to run a live Interactive Full Stack Experience or a live Interactive Full Stack Experiment only. Other types of experiences and experiments (Web, Triggered Full Stack) are run by the Boxever JavaScript Library automatically.

You can find the friendlyId in Sitecore Personalize, in a live interactive full stack experience or experiment, by clicking Summary. The friendlyId is in Details > Friendly ID.

Parameters

Parameter	Type	Description	Note
`flow`	object	Event and experiment data.	Specify the `friendlyId` in this object.
`callback`	function	This callback function handles the response.	N/A

Return value

object

Example

In a flow object, specify the friendlyId of the experience or experiment that you want to run, and one guest identifier attribute, for example, the browser ID. Then, pass the object to the callFlows() function:

const flowObject = {
    clientKey: Boxever.getClientKey(),
    friendlyId: "running_shoes_popup_02",
    channel: "WEB",
    language: "EN",
    currencyCode: "EUR",
    pointOfSale: "myretailsite/ireland",
    // guest identifier:
    browserId: Boxever.getID()
};

Boxever.callFlows(
    flowObject,
    response => console.log(response)
);

If you have suggestions for improving this article, let us know!