Disclaimer: This website requires Please enable JavaScript in your browser settings for the best experience.

The availability of features may depend on your plan type. Contact your Customer Success Manager if you have any questions.

Dev GuideRecipesAPI ReferenceChangelogDiscussions
Dev GuideAPI ReferenceUser GuideGitHubDev CommunityOptimizely AcademySubmit a ticketLog In
API Reference

Hold events

Instruct the Optimizely Web Experimentation snippet to hold and enqueue events.

Syntax

window["optimizely"].push(holdEvents);

Parameters

Parameter and Type

Child Attribute

Description

holdEvents HoldEventsObject

An object with the type field set to holdEvents. The other fields are the function arguments. Required.

type
string

Child attribute of type HoldEventsObject

The argument indicating that you're using the holdEvents function. Required.

Example Call

window["optimizely"].push({
  "type": "holdEvents"
});

Description

Use in conjunction with sendEvents for granular control over the timing of when the Optimizely Web Experimentation snippet sends events to the logging endpoint.