The onEventReceive API enables listening to key VWO lifecycle events and executing custom actions when these events occur. This is useful for tracking conversions, handling variations, managing redirections, and optimizing user experience dynamically.
JavaScript
window.VWO = window.VWO || [];
VWO.push(['onEventReceive', <event_name>, <callback_function>]);
Parameter Type Required Description event_namestringYes The event to listen for (e.g., 'vA' for "Variation Applied"). callback_functionFunctionYes Function executed when the event is triggered.
Type: Array - [<eventName>, <experimentId>, <goalId>]
Element Type Description eventNamestringName of the triggered VWO event. experimentIdstringID of the experiment the visitor is bucketed into. goalIdstringID of the campaign goal that gets triggered.
Event Name Description Use Cases vA (Variation Applied)Fired when a variation is successfully applied. Ensure visual changes are applied, trigger UI updates. vAE (Variation Application Error)Fired when errors occur when variation changes are applied. Track errors for rectifying custom variation changes and fallback execution if any. rC (Goal Conversion)Fired when a visitor triggers a goal. Send conversion data to analytics, log server-side events. uC (URL Change)Fired when a tracked URL change occurs. Update tracking parameters, adjust single-page app (SPA) URLs dynamically. uAV (Unhide All Variations)Fired when all hidden variations are revealed. Ensure variation visibility for debugging or custom logic. hC (Post URL Change)Fired after a URL change is detected. Execute post-navigation actions like analytics tracking. bRTR (Before Redirect to URL Unhide Variation)Fired before a redirect where a variation is unhidden. Handle pre-redirect processing or adjustments. rD (Redirect Decision)Fired when a redirect decision is made. Log or modify redirect behavior based on campaign logic. nR (Not Redirecting)Fired when a redirection does not happen. Track cases where expected redirection is skipped. hCl (Heatmap Click)Fired when a visitor clicks on a heatmap-tracked element. Analyze user behavior, trigger session recording. tSC (Track Session Created)Fired when a new session is tracked. Log session creation, initialize session-based tracking. nS (New Session)Fired when a visitor starts a new session. Personalize experience based on session status. sE (Segmentation Evaluated)Fired when segmentation conditions are evaluated. Modify experience dynamically based on user segments. tNR (Test Not Running)Fired when a test is determined to be inactive. Ensure fallback behavior when experiments are off. hE (Hide Elements)Fired when elements are hidden. Track hidden elements and adjust UI dynamically.
JavaScript
window.VWO.push(['onEventReceive', 'uC', function () {
window._vis_opt_url = ''; // Reset custom URL
}]);
JavaScript
window.VWO.push(['onEventReceive', 'rC', function (data) {
const [eventName, experimentId, goalId] = data;
console.log(`Goal ${goalId} triggered in Experiment ${experimentId}`);
}]);
JavaScript
window.VWO.push(['onEventReceive', 'cC', function (data) {
const [eventName, experimentId] = data;
console.log(`User bucketed in Experiment ${experimentId} before applying changes.`);
}]);
JavaScript
window.VWO.push(['onEventReceive', 'vA', function (data) {
const [eventName, experimentId] = data;
console.log(`Variation applied for Experiment ${experimentId}`);
}]);
JavaScript
window.VWO.push(['onEventReceive', 'vAE', function (data) {
const [eventName, experimentId, variationId, error] = data;
console.log(`${error.toString()} occured in ${variationId} variation of campaign id ${experimentId}`);
}]);
JavaScript
window.VWO.push(['onEventReceive', 'vA', function (data) {
const [eventName, experimentId] = data;
console.log(`Variation applied for Experiment ${experimentId}`);
}]);
JavaScript
window.VWO.push(['onEventReceive', 'vAE', function (data) {
const [eventName, experimentId, variationId, error] = data;
console.log(`${error.toString()} occured in ${variationId} variation of campaign id ${experimentId}`);
}]);
