Top
Login
Contents x
List of Whatfix Functions
  • 01 Sep 2022
  • 16 Minutes To Read
  • Print
  • Dark
    Light
  • PDF
Contents

List of Whatfix Functions

  • Updated On 01 Sep 2022
  • 16 Minutes To Read
  • Print
  • Dark
    Light
  • PDF

Whatfix functions enable you to utilize additional functionalities and configurations using code that is added in the Advanced Customization section.

Here is an example function to display a pop-up when the user completes a specific step in a Flow.

function onNext(event) 
{
  if(event.flow_id == '+' && event.step == '+')
  {
    var pop1 = document.querySelectorAll('.gwt-PopupPanel')[1];
    pop1.parentNode.removeChild(pop1);
  }
}
window._wfx_settings = {onNext: onEvent};

Flow Functions

FunctionPurposeExample Code Snippet
onStartCallback after the Flow starts
function onStart(event){
   track(event.path, event.flow_id, event.flow_title, event.ent_id, event.src_id, event.on_id, event.interaction_id, event.user_id, event.step);
}
function track(var path, var flow_id, var flow_title, var ent_id, var src_id, var on_id, var interaction_id, var step, var content, var user_id){
 
//Your implementation goes here
console.log(path + ", " + flow_id + ", " + flow_title + ", " + ent_id + ", " + src_id + ", " + on_id + ", " + interaction_id + ", " +
user_id step + ", " + user_id + ", " + content);
}
window._wfx_settings.tracker = { trackLiveStart:OnStart };

onMissCallback 

when Flow step is missed

function onMiss(event) {
   track(null, event.flow_id, event.flow_title, event.ent_id, event.src_id, event.on_id, event.interaction_id, event.user_id, null, event.content);
}
function track(var path, var flow_id, var flow_title, var ent_id, var src_id, var on_id, var interaction_id, var step, var content, var user_id){
 
//Your implementation goes here
console.log(path + ", " + flow_id + ", " + flow_title + ", " + ent_id + ", " + src_id + ", " + on_id + ", " + interaction_id + ", " +
user_id step + ", " + user_id + ", " + content);
}
window._wfx_settings.tracker = {trackLiveMiss:OnMiss};

onCloseCallback when the Flow is closed
function onClose(event) {
   track(null, event.flow_id, event.flow_title, event.ent_id, event.src_id, event.on_id, event.interaction_id, event.user_id, null, event.content);
}
function track(var path, var flow_id, var flow_title, var ent_id, var src_id, var on_id, var interaction_id, var step, var content, var user_id){
 
//Your implementation goes here
console.log(path + ", " + flow_id + ", " + flow_title + ", " + ent_id + ", " + src_id + ", " + on_id + ", " + interaction_id + ", " +
user_id step + ", " + user_id + ", " + content);
}
window._wfx_settings.tracker = { trackLiveClose:OnClose };

onEndCallback when the Flow is complete
function onEnd(event) {
   track(null, event.flow_id, event.flow_title, event.ent_id, event.src_id, event.on_id, event.interaction_id, event.user_id, null, event.content);
}
function track(var path, var flow_id, var flow_title, var ent_id, var src_id, var on_id, var interaction_id, var step, var content, var user_id){
 
//Your implementation goes here
console.log(path + ", " + flow_id + ", " + flow_title + ", " + ent_id + ", " + src_id + ", " + on_id + ", " + interaction_id + ", " +
user_id step + ", " + user_id + ", " + content);
}
window._wfx_settings.tracker = {trackLiveEnd:OnEnd};
onFlowFeedbackCallback when the Flow feedback is submitted
function onFlowFeedback(event) {
   track(null, event.flow_id, event.flow_title, event.ent_id, event.src_id, event.on_id, event.interaction_id, event.user_id, null, event.content);
}
function track(var path, var flow_id, var flow_title, var ent_id, var src_id, var on_id, var interaction_id, var step, var content, var user_id){
 
//Your implementation goes here
console.log(path + ", " + flow_id + ", " + flow_title + ", " + ent_id + ", " + src_id + ", " + on_id + ", " + interaction_id + ", " +
user_id step + ", " + user_id + ", " + content);
}
window._wfx_settings.tracker = {trackFlowFeedback:OnFlowFeedback};

onBeforeEndCallback before the Flow ends
function onBeforeEnd(event)
{
//Your implementation goes here
}
window._wfx_settings = {onBeforeEnd: onEvent};

onBeforeShowCallback before the step is shown
function onBeforeShow(event)
{
//Your implementation goes here
}
window._wfx_settings = {onBeforeShow: onEvent};

onAfterShow

Callback after the step is shown


function onAfterShow(event)
{
//Your implementation goes here
}
window._wfx_settings = {onAfterShow: onEvent};

onBeforeStartCallback before the Flow starts
function onBeforeStart(event)
{
//Your implementation goes here
}
window._wfx_settings = {onBeforeStart: onEvent};

onNextCallback on click of next button
function onNext(event)
{
//Your implementation goes here
}
window._wfx_settings = {onNext: onEvent};


Self Help Functions

FunctionPurposeExample Code Snippet
onWidgetClickCallback when the user clicks on the Self Help and opens it
function onWidgetClick(event) {
   track(event.path, event.ent_id, event.src_id, event.on_id, event.interaction_id, event.user_id); //path : '/widget'
}
function track(var path, var ent_id, var src_id, var on_id, var interaction_id, var user_id){
//Your implementation goes here
console.log(path + ", " + ent_id + ", " + src_id + ", " + on_id + "," + ", " + interaction_id + ", " + user_id);
}
 
window._wfx_settings.tracker = {trackSelfHelpOpened:onWidgetClick};

onSelfHelpCloseCallback when the Self Help widget is closed
function onSelfHelpClose(event) {
   track(event.path, event.ent_id, event.src_id, event.on_id, event.interaction_id, event.user_id); //path : '/widget'
}
function track(var path, var ent_id, var src_id, var on_id, var interaction_id, var user_id){
//Your implementation goes here
console.log(path + ", " + ent_id + ", " + src_id + ", " + on_id + "," + ", " + interaction_id + ", " + user_id);
}
 
window._wfx_settings.tracker = {trackSelfHelpClosed:OnSelfHelpClose};

onSelfHelpShowCallback

when the Self Help widget appears on the user screen.


function onSelfHelpShow(event) {
   track(event.path, event.ent_id, event.src_id, event.on_id, event.interaction_id, event.user_id); //path : '/widget'
}
function track(var path, var ent_id, var src_id, var on_id, var interaction_id, var user_id){
//Your implementation goes here
console.log(path + ", " + ent_id + ", " + src_id + ", " + on_id + "," + ", " + interaction_id + ", " + user_id);
}
 
window._wfx_settings.tracker = {trackSelfHelpShown:OnSelfHelpShow};

onSelfhelpSearchCallback 

when user searches in Self Help


function onSelfhelpSearch(event) {
   track(event.path, event.ent_id, event.src_id, event.on_id, event.interaction_id, event.user_id); //path : '/widget'
}
function track(var path, var ent_id, var src_id, var on_id, var interaction_id, var user_id){
//Your implementation goes here
console.log(path + ", " + ent_id + ", " + src_id + ", " + on_id + "," + ", " + interaction_id + ", " + user_id);
}
 
window._wfx_settings.tracker = {trackSearch:OnSelfhelpSearch};

onGroupOpenCallback 

when user opens a group

function onGroupOpen(event) {
   track(event.path, event.ent_id, event.src_id, event.on_id, event.interaction_id, event.user_id); //path : '/widget'
}
function track(var path, var ent_id, var src_id, var on_id, var interaction_id, var user_id){
//Your implementation goes here
console.log(path + ", " + ent_id + ", " + src_id + ", " + on_id + "," + ", " + interaction_id + ", " + user_id);
}
 
window._wfx_settings.tracker = {trackGroupOpen:OnGroupOpen};

onGroupClose

Callback when user closes a group

function onGroupClose(event) {
   track(event.path, event.ent_id, event.src_id, event.on_id, event.interaction_id, event.user_id); //path : '/widget'
}
function track(var path, var ent_id, var src_id, var on_id, var interaction_id, var user_id){
//Your implementation goes here
console.log(path + ", " + ent_id + ", " + src_id + ", " + on_id + "," + ", " + interaction_id + ", " + user_id);
}
 
window._wfx_settings.tracker = {trackGroupClose:OnGroupClose};

onSearchCrossCallback when the cross icon in the search field is clicked
function onSearchCross(event) {
   track(event.path, event.ent_id, event.src_id, event.on_id, event.interaction_id, event.user_id); //path : '/widget'
}
function track(var path, var ent_id, var src_id, var on_id, var interaction_id, var user_id){
//Your implementation goes here
console.log(path + ", " + ent_id + ", " + src_id + ", " + on_id + "," + ", " + interaction_id + ", " + user_id);
}
 
window._wfx_settings.tracker = {trackSearchCross:OnSearchCross};

onSearchScrollCallback when a user scrolls in Self Help
function onSearchScroll(event) {
   track(event.path, event.ent_id, event.src_id, event.on_id, event.interaction_id, event.user_id); //path : '/widget'
}
function track(var path, var ent_id, var src_id, var on_id, var interaction_id, var user_id){
//Your implementation goes here
console.log(path + ", " + ent_id + ", " + src_id + ", " + on_id + "," + ", " + interaction_id + ", " + user_id);
}
 
window._wfx_settings.tracker = {trackSearchScroll:OnSearchScroll};

onVideoStart    Callback when video content is clicked
function onVideoStart(event) {
   track(event.path, event.ent_id, event.src_id, event.on_id, event.interaction_id, event.user_id); //path : '/widget'
}
function track(var path, var ent_id, var src_id, var on_id, var interaction_id, var user_id){
//Your implementation goes here
console.log(path + ", " + ent_id + ", " + src_id + ", " + on_id + "," + ", " + interaction_id + ", " + user_id);
}
 
window._wfx_settings.tracker = {trackVideoStart:OnVideoStart};

onLinkStart

Callback when link content is clicked


function onLinkStart(event) {
   track(event.path, event.ent_id, event.src_id, event.on_id, event.interaction_id, event.user_id); //path : '/widget'
}
function track(var path, var ent_id, var src_id, var on_id, var interaction_id, var user_id){
//Your implementation goes here
console.log(path + ", " + ent_id + ", " + src_id + ", " + on_id + "," + ", " + interaction_id + ", " + user_id);
}
 
window._wfx_settings.tracker = {trackLinkStart:OnLinkStart};

onTextStart    Callback when text content is opened
function onTextStart(event) {
   track(event.path, event.ent_id, event.src_id, event.on_id, event.interaction_id, event.user_id); //path : '/widget'
}
function track(var path, var ent_id, var src_id, var on_id, var interaction_id, var user_id){
//Your implementation goes here
console.log(path + ", " + ent_id + ", " + src_id + ", " + on_id + "," + ", " + interaction_id + ", " + user_id);
}
 
window._wfx_settings.tracker = {trackTextStart:OnTextStart};

onTextEndCallback 

when text content is closed


function onTextEnd(event) {
   track(event.path, event.ent_id, event.src_id, event.on_id, event.interaction_id, event.user_id); //path : '/widget'
}
function track(var path, var ent_id, var src_id, var on_id, var interaction_id, var user_id){
//Your implementation goes here
console.log(path + ", " + ent_id + ", " + src_id + ", " + on_id + "," + ", " + interaction_id + ", " + user_id);
}
 
window._wfx_settings.tracker = {trackTextEnd:OnTextEnd};


Task List Functions

FunctionPurposeExample Code Snippet
onWidgetClickedCallback 

when the Task List widget is clicked

function onWidgetClicked(event) {
   track(event.path, event.ent_id, event.src_id, event.on_id, event.interaction_id, event.user_id); //src_id : '/tasker'
}
function track(var path, var ent_id, var src_id, var on_id, var interaction_id, var user_id){
//Your implementation goes here
console.log(path + ", " + ent_id + ", " + src_id + ", " + on_id + "," + ", " + interaction_id + ", " + user_id);
}
 
window._wfx_settings.tracker = {trackTaskListOpened:onWidgetClicked};

onWidgetLoadedCallback when the Task List is opened
function onWidgetLoaded(event) {
   track(event.path, event.ent_id, event.src_id, event.on_id, event.interaction_id, event.user_id); //src_id : '/tasker'
}
function track(var path, var ent_id, var src_id, var on_id, var interaction_id, var user_id){
//Your implementation goes here
console.log(path + ", " + ent_id + ", " + src_id + ", " + on_id + "," + ", " + interaction_id + ", " + user_id);
}
 
window._wfx_settings.tracker = {trackTaskListShown:OnWidgetLoaded};

onWidgetScrollCallback when the tasks in the Task List is scrolled
function onWidgetScroll(event) {
   track(event.path, event.ent_id, event.src_id, event.on_id, event.interaction_id, event.user_id); //src_id : '/tasker'
}
function track(var path, var ent_id, var src_id, var on_id, var interaction_id, var user_id){
//Your implementation goes here
console.log(path + ", " + ent_id + ", " + src_id + ", " + on_id + "," + ", " + interaction_id + ", " + user_id);
}
 
window._wfx_settings.tracker = {trackWidgetScroll:OnWidgetScroll};

onWidgetClose    Callback when the Task List is closed using the close icon
function onWidgetClose(event) {
   track(event.path, event.ent_id, event.src_id, event.on_id, event.interaction_id, event.user_id); //src_id : '/tasker'
}
function track(var path, var ent_id, var src_id, var on_id, var interaction_id, var user_id){
//Your implementation goes here
console.log(path + ", " + ent_id + ", " + src_id + ", " + on_id + "," + ", " + interaction_id + ", " + user_id);
}
 
window._wfx_settings.tracker = {trackTaskListClosed:OnWidgetClose};


Pop-up Functions

Analytics Callbacks

FunctionPurpose  Example Code Snippet
trackNewPopupShown
Callback when the Pop-up is loaded.
function trackNewPopupShown(event) { //path : '/popup/loaded’
   track(event.path, event.ent_id, event.src_id, event.on_id, event.interaction_id, event.user_id);
}
function track(var path, var ent_id, var src_id, var on_id, var interaction_id, var user_id){
//Your implementation goes here
console.log(path + ", " + ent_id + ", " + src_id + ", " + on_id + "," + ", " + interaction_id + ", " + user_id);
}
 
window._wfx_settings.tracker = {trackNewPopupShown:trackNewPopupShown};

trackNewPopupSkip
Callback when the Pop-up is skipped by the user.
function trackNewPopupSkip(event) { //path : '/popup/clicked/skip’
   track(event.path, event.ent_id, event.src_id, event.on_id, event.interaction_id, event.user_id);
}
function track(var path, var ent_id, var src_id, var on_id, var interaction_id, var user_id){
//Your implementation goes here
console.log(path + ", " + ent_id + ", " + src_id + ", " + on_id + "," + ", " + interaction_id + ", " + user_id);
}
 
window._wfx_settings.tracker = {trackNewPopupSkip:trackNewPopupSkip};

trackNewPopupStartFlow
Callback when clicking the Pop-up leads to another Flow.
function trackNewPopupStartFlow(event) { //path : '/popup/clicked/flow/{buttonText}’
   track(event.path, event.ent_id, event.src_id, event.on_id, event.interaction_id, event.user_id);
}
function track(var path, var ent_id, var src_id, var on_id, var interaction_id, var user_id){
//Your implementation goes here
console.log(path + ", " + ent_id + ", " + src_id + ", " + on_id + "," + ", " + interaction_id + ", " + user_id);
}
 
window._wfx_settings.tracker = {trackNewPopupStartFlow:trackNewPopupStartFlow};

trackNewPopupStartUrl
Callback when clicking the Pop-up leads to a link or a URL. 
function trackNewPopupStartUrl(event) { //path : '/popup/clicked/url/{buttonText}’
   track(event.path, event.ent_id, event.src_id, event.on_id, event.interaction_id, event.user_id);
}
function track(var path, var ent_id, var src_id, var on_id, var interaction_id, var user_id){
//Your implementation goes here
console.log(path + ", " + ent_id + ", " + src_id + ", " + on_id + "," + ", " + interaction_id + ", " + user_id);
}
 
window._wfx_settings.tracker = {trackNewPopupStartUrl:trackNewPopupStartUrl};

trackNewPopupClose
Callback when the Pop-up is closed. 
function trackNewPopupClose(event) { //path : '/popup/clicked/close’
   track(event.path, event.ent_id, event.src_id, event.on_id, event.interaction_id, event.user_id);
}
function track(var path, var ent_id, var src_id, var on_id, var interaction_id, var user_id){
//Your implementation goes here
console.log(path + ", " + ent_id + ", " + src_id + ", " + on_id + "," + ", " + interaction_id + ", " + user_id);
}
 
window._wfx_settings.tracker = {trackNewPopupClose:trackNewPopupClose};

trackNewPopupDoNotShow
Callback when the user clicks Do Not Show Again option on a Pop-up.
function trackNewPopupDoNotShow(event) { //path : '/popup/checked/dontShow’
   track(event.path, event.ent_id, event.src_id, event.on_id, event.interaction_id, event.user_id);
}
function track(var path, var ent_id, var src_id, var on_id, var interaction_id, var user_id){
//Your implementation goes here
console.log(path + ", " + ent_id + ", " + src_id + ", " + on_id + "," + ", " + interaction_id + ", " + user_id);
}
 
window._wfx_settings.tracker = {trackNewPopupDoNotShow:trackNewPopupDoNotShow};

onEndPopUpCloseFromButton    Callback when the Pop-up (after the Flow) is closed using the CLOSE button.
function onEndPopUpCloseFromButton(event) { //path : '/popup/guided_popup/start/popup_name' or '/popup/smart_popup/start/popup_name'
   track(event.path, event.ent_id, event.src_id, event.on_id, event.interaction_id, event.user_id);
}
function track(var path, var ent_id, var src_id, var on_id, var interaction_id, var user_id){
//Your implementation goes here
console.log(path + ", " + ent_id + ", " + src_id + ", " + on_id + "," + ", " + interaction_id + ", " + user_id);
}
 
window._wfx_settings.tracker = {trackEndPopUpCloseFromButton:OnEndPopUpCloseFromButton};

onEndPopUpCloseFromCrossCallback when the Pop-up (after the Flow) is closed using the close icon.
function onEndPopUpCloseFromCross(event) { //path : '/popup/guided_popup/start/popup_name' or '/popup/smart_popup/start/popup_name'
   track(event.path, event.ent_id, event.src_id, event.on_id, event.interaction_id, event.user_id);
}
function track(var path, var ent_id, var src_id, var on_id, var interaction_id, var user_id){
//Your implementation goes here
console.log(path + ", " + ent_id + ", " + src_id + ", " + on_id + "," + ", " + interaction_id + ", " + user_id);
}
 
window._wfx_settings.tracker = {trackEndPopUpCloseFromCross:OnEndPopUpCloseFromCross};

onEndPopUpCloseFromFlowClickCallback when the close icon in the Flow tip is clicked.
function OnEndPopUpCloseFromFlowClick(event) { //path : '/popup/guided_popup/start/popup_name' or '/popup/smart_popup/start/popup_name'
   track(event.path, event.ent_id, event.src_id, event.on_id, event.interaction_id, event.user_id);
}
function track(var path, var ent_id, var src_id, var on_id, var interaction_id, var user_id){
//Your implementation goes here
console.log(path + ", " + ent_id + ", " + src_id + ", " + on_id + "," + ", " + interaction_id + ", " + user_id);
}
 
window._wfx_settings.tracker = {trackEndPopUpCloseFromFlowClick:OnEndPopUpCloseFromFlowClick};

Non-analytics Callbacks

FunctionPurposeOnline or Offline? Example Code Snippet
onPopupCloseCallback when the Pop-up is closed. Online
function onPopupClose(object)
{
   //Your implementation goes here
}
window._wfx_settings = {onPopupClose: onPopupClose};

onPopupSuccessCallback when a Flow or content is triggered from a Pop-up. Online
function onPopupSuccess(object)
{
   //Your implementation goes here
}
window._wfx_settings = {onPopupSuccess: onPopupSuccess};

onPopupSkipCallback when the Pop-up is skipped by the user. Online
function onPopupSkip(object)
{
   //Your implementation goes here
}
window._wfx_settings = {onPopupSkip: onPopupSkip};

onBeforePopUpShowCallback before the Pop-up is displayed to the user. Online
function onBeforePopUpShow(object)
{
   //Your implementation goes here
}
window._wfx_settings = {onBeforePopupShow: onBeforePopupShow};
onPopupViewCallback when the Pop-up is viewed by the user.Offline
function onPopupView(object)
{
   //Your implementation goes here
}
window._wfx_settings = {onPopupView: onPopupView};

onDontShowPopupCallback when the user clicks Do Not Show option in a Pop-up.Offline
function onDontShowPopup(object)
{
   //Your implementation goes here
}
window._wfx_settings = {onDontShowPopup: onDontShowPopup};

getPopupViewCountCallback to get the number of users who viewed the Pop-up.Offline
function onPopupViewCount(object)
{
   //Your implementation goes here
}
window._wfx_settings = {onPopupViewCount: onPopupViewCount};

Smart Tip Functions

Function PurposeExample Code Snippet
onStaticShow
Callback for each time the Smart Tip is shown
function onStaticShow(event) {//path : '/smart_tip/live/step1'
   track(event.path, event.flow_id, event.flow_title, event.ent_id, event.src_id, event.on_id, event.user_id, event.step);
}
function track(var path, var flow_id, var flow_title, var ent_id, var src_id, var on_id, var step, var content, var user_id){
//Your implementation goes here
console.log(path + ", " + flow_id + ", " + flow_title + ", " + ent_id + ", " + src_id + ", " + on_id + ", " + interaction_id + ", " +
user_id step + ", " + user_id + ", " + content);
}
 
window._wfx_settings.tracker = {trackStaticShow:onShow};

onStaticClose
Callback when the Smart Tip is closed by pressing the cross icon
function onStaticClose(event) {//path : '/smart_tip/live/close1'
   track(event.path, event.flow_id, event.flow_title, event.ent_id, event.src_id, event.on_id, event.user_id);
}
function track(var path, var flow_id, var flow_title, var ent_id, var src_id, var on_id, var step, var content, var user_id){
//Your implementation goes here
console.log(path + ", " + flow_id + ", " + flow_title + ", " + ent_id + ", " + src_id + ", " + on_id + ", " + interaction_id + ", " +
user_id step + ", " + user_id + ", " + content);
}
 
window._wfx_settings.tracker = {trackStaticClose:onClose};


Callback if the step is missed
function onStaticMiss(event) {path : '/smart_tip/live/miss1'
   track(event.path, event.flow_id, event.flow_title, event.ent_id, event.on_id, event.user_id, event.step);
}
function track(var path, var flow_id, var flow_title, var ent_id, var src_id, var on_id, var step, var content, var user_id){
//Your implementation goes here
console.log(path + ", " + flow_id + ", " + flow_title + ", " + ent_id + ", " + src_id + ", " + on_id + ", " + interaction_id + ", " +
user_id step + ", " + user_id + ", " + content);
}
 
window._wfx_settings.tracker = {trackStaticMiss:onMiss};

onValidationValid
Callback

when validation is passed



function onValidationValid(event) {path : '/smart_tip/live/miss1'
   track(event.path, event.flow_id, event.flow_title, event.ent_id, event.on_id, event.user_id, event.step);
}
function track(var path, var flow_id, var flow_title, var ent_id, var src_id, var on_id, var step, var content, var user_id){
//Your implementation goes here
console.log(path + ", " + flow_id + ", " + flow_title + ", " + ent_id + ", " + src_id + ", " + on_id + ", " + interaction_id + ", " +
user_id step + ", " + user_id + ", " + content);
}
 
window._wfx_settings.tracker = {trackTipValidationValid:OnValidationValid};

onValidationError    Callback when a validation error occurs
function onValidationError(event) {path : '/smart_tip/live/miss1'
   track(event.path, event.flow_id, event.flow_title, event.ent_id, event.on_id, event.user_id, event.step);
}
function track(var path, var flow_id, var flow_title, var ent_id, var src_id, var on_id, var step, var content, var user_id){
//Your implementation goes here
console.log(path + ", " + flow_id + ", " + flow_title + ", " + ent_id + ", " + src_id + ", " + on_id + ", " + interaction_id + ", " +
user_id step + ", " + user_id + ", " + content);
}
 
window._wfx_settings.tracker = {trackTipValidationError:OnValidationError};

onValidationRectified   
Callback when a validation error is rectified
function onValidationRectified(event) {path : '/smart_tip/live/miss1'
   track(event.path, event.flow_id, event.flow_title, event.ent_id, event.on_id, event.user_id, event.step);
}
function track(var path, var flow_id, var flow_title, var ent_id, var src_id, var on_id, var step, var content, var user_id){
//Your implementation goes here
console.log(path + ", " + flow_id + ", " + flow_title + ", " + ent_id + ", " + src_id + ", " + on_id + ", " + interaction_id + ", " +
user_id step + ", " + user_id + ", " + content);
}
 
window._wfx_settings.tracker = {trackTipValidationRectified:OnValidationRectified};


Beacon Functions

FunctionsPurposeExample Code Snippet
onBeaconClicked    
Callback when
a Beacon is clicked
function onBeaconClicked(event) {
   track(event.path, event.flow_id, event.flow_title, event.ent_id, event.src_id, event.on_id, event.user_id, event.step);
}
function track(var path, var flow_id, var flow_title, var ent_id, var src_id, var on_id, var step, var content, var user_id){
//Your implementation goes here
console.log(path + ", " + flow_id + ", " + flow_title + ", " + ent_id + ", " + src_id + ", " + on_id + ", " + interaction_id + ", " +
user_id step + ", " + user_id + ", " + content);
}
 
window._wfx_settings.tracker = {trackBeaconClicked:OnBeaconClicked};

onBeaconShown    
Callback when a Beacon appears on the user screen
function onBeaconShown(event) {
   track(event.path, event.flow_id, event.flow_title, event.ent_id, event.src_id, event.on_id, event.user_id);
}
function track(var path, var flow_id, var flow_title, var ent_id, var src_id, var on_id, var step, var content, var user_id){
//Your implementation goes here
console.log(path + ", " + flow_id + ", " + flow_title + ", " + ent_id + ", " + src_id + ", " + on_id + ", " + interaction_id + ", " +
user_id step + ", " + user_id + ", " + content);
}
 
window._wfx_settings.tracker = {trackBeaconShown:OnBeaconShown};

onWidgetLoadedEvent
Callback when a Beacon content is loaded
function onWidgetLoadedEvent(event) {
   track(event.path, event.flow_id, event.flow_title, event.ent_id, event.src_id, event.on_id, event.user_id);
}
function track(var path, var flow_id, var flow_title, var ent_id, var src_id, var on_id, var step, var content, var user_id){
//Your implementation goes here
console.log(path + ", " + flow_id + ", " + flow_title + ", " + ent_id + ", " + src_id + ", " + on_id + ", " + interaction_id + ", " +
user_id step + ", " + user_id + ", " + content);
}
 
window._wfx_settings.tracker = {trackWidgetLoadedEvent:OnWidgetLoadedEvent};


Was this article helpful?
What's Next
Privacy Policy | Whatfix Glossary | Whatfix Platform Status
Copyright © 2022 WHATFIX TM. All rights reserved.
Change password!
Changing your password will log you out immediately. Use the new password to log back in.
Change profile
Success!
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.
Logout