Whatfix Mobile Events

Whatfix Mobile generates specific events when your end user interacts with the Walkthrough or elements. These events are used by Whatfix Mobile to generate insights on your Dashboard. Whatfix also enables you to send these events to third-party platforms through integrations or custom code.

There are two entities that constitute Whatfix Mobile's in-app engagement platform:
Element: To drive a single interaction on any particular screen.
Flow: To drive multiple interactions across different screens. It contains one or more elements.

The following are the Whatfix Mobile events that are generated:

flow_start

This event is generated in the following scenarios:

• When a user sees the Start Screen (configured from the Dashboard).
• When a user clicks the Icon and the Walkthrough is triggered.

It means that the Walkthrough has been shown to the end user on the screen but the user didn't interact with the Walkthrough. This event precedes flow opt in/flow opt-out event.

Validity: Flow

Event properties:

{
	"projectName" : "", //Name of project in dashboard
	"language" : "ang", //current leap language for this event
	"timestamp" : "2021-03-28T09:26:55Z", 
	"eventName" : "flow_start",
	"deploymentName" : "", //Name of deployment in dashboard
	"id" : "", // unique id for the event
	"deploymentVersion": "", //version of deployment
	"projectId" :"" // This key is sent only when project is started with startProject
}

flow_opt_in

This event is generated when a user opts-in for the Whatfix Mobile experience. It means that the user has clicked on button to start a Walkthrough, and it has started on the mobile screen. This event succeeds the flow_start event.
Validity: Flow
Event properties:

{
	"projectName" : "", //Name of project in dashboard
	"language" : "ang", //current leap language for this event
	"timestamp" : "2021-03-28T09:26:55Z", 
	"eventName" : "flow_opt_in",
	"deploymentName" : "", //Name of deployment in dashboard	
	"id" : "", // unique id for the event
	"deploymentVersion": "", //version of deployment
	"projectId" :"" // This key is sent only when project is started with startProject
}

flow_opt_out

This event is generated when a user opts out of the Whatfix Mobile experience. It means that the user has clicked on the dismiss button or cross icon to close the Walkthrough when it started on screen. This event succeeds the flow_start event.

The event is generated in the following scenarios:

• When a user clicks the dismiss button in the discovery
• When a user clicks a cross button in the discovery
• When a user clicks outside the discovery, that is, Popup, BottomUp, Highlight, Tooltip, and more.
• When a user goes to another screen without selecting anything in the Ping Discovery

Validity: Flow
Event properties:

{
	"projectName" : "", //Name of project in dashboard
	"language" : "ang", //current leap language for this event
	"timestamp" : "2021-03-28T09:26:55Z", 
	"eventName" : "flow_opt_out",
	"deploymentName" : "", //Name of deployment in dashboard
	"id" : "", // unique id for the event
	"deploymentVersion": "", //version of deployment
	"projectId" :"" // This key is sent only when project is started with startProject
}

element_seen

This event is generated when a user sees a Whatfix Mobile element. An element may or may not have audio.
Validity: Flow and Elements
Event properties (for Flows):

{
	"projectName" : "", //Name of project in dashboard
	"language" : "ang", //current leap language for this event
	"timestamp" : "2021-03-28T09:26:55Z",
	"eventName" : "element_seen",
	"pageName" : "", //Name of page in dashboard
	"instructionName" : "", //Name of instruction in dashboard
	"deploymentName" : "", //Name of deployment in dashboard
	"id" : "", // unique id for the event
	"deploymentVersion": "", //version of deployment
	"projectId" :"" // This key is sent only when project is started with startProject
}

Event properties (for Elements):

{
	"projectName" : "", //Name of project in dashboard
	"language" : "ang", //current leap language for this event
	"timestamp" : "2021-03-28T09:26:55Z",
	"eventName" : "element_seen",
	"instructionName" : "", //Name of instruction in dashboard
	"deploymentName" : "", //Name of deployment in dashboard
	"id" : "", // unique id for the event
	"deploymentVersion": "", //version of deployment
	"projectId" :"" // This key is sent only when project is started with startProject
}

flow_success

This event is generated when the flow is completed successfully. The event occus if a step is marked as EXIT FLOW on the Dashboard.
Validity: Flow
Event properties:

{
	"projectName" : "", //Name of project in dashboard
	"language" : "ang", //current leap language for this event
	"timestamp" : "2021-03-28T09:26:55Z",
	"eventName" : "flow_success",
	"instructionName" : "", //Name of instruction in dashboard
	"deploymentName" : "", //Name of deployment in dashboard
	"id" : "", // unique id for the event
	"deploymentVersion": "", //version of deployment
	"projectId" :"" // This key is sent only when project is started with startProject
}

flow_stop

This event is generated when a user stops a Flow by clicking the Stop button in the Whatfix Mobile Icon.

Validity: Flow (because a Flow project has a Whatfix Mobile icon)
Event properties:

{
	"projectName" : "", //Name of project in dashboard
	"language" : "ang", //current leap language for this event
	"timestamp" : "2021-03-28T09:26:55Z",
	"eventName" : "flow_stop",
	"pageName" : "", //Name of page in dashboard
	"instructionName" : "", //Name of instruction in dashboard
	"deploymentName" : "", //Name of deployment in dashboard
	"id" : "", // unique id for the event
	"deploymentVersion": "", //version of deployment
	"projectId" :"" // This key is sent only if when project is started with startProject
}

flow_disable

This event is generated when a user drags the Whatfix Mobile icon to the cross symbol on the bottom, and then agrees to disable it by clicking Yes.
Validity: Flow (because a Flow project has a Whatfix Mobile icon)
Event properties:

{
	"projectName" : "", //Name of project in dashboard
	"language" : "ang", //current leap language for this event
	"timestamp" : "2021-03-28T09:26:55Z",
	"eventName" : "flow_disable",
	"pageName" : "", //Name of page in dashboard
	"instructionName" : "", //Name of instruction in dashboard
	"deploymentName" : "", //Name of deployment in dashboard
	"id" : "", // unique id for the event
	"deploymentVersion": "", //version of deployment
	"projectId" :"" // This key is sent only when project is started with startProject
}

flow_language_change

This event is generated when a user changes the language in Whatfix Mobile.
Validity: Flow (because a Flow project has a Whatfix Mobile icon)
Event properties:

{
	"projectName" : "", //Name of project in dashboard
	"previousLanguage" : "ang" //previous language
	"language" : "hin", // new language selected
	"timestamp" : "2021-03-28T09:26:55Z", 
	"eventName" : "flow_language_change",
	"deploymentName" : "", //Name of deployment in dashboard
	"id" : "", // unique id for the event
	"deploymentVersion": "", //version of deployment
	"projectId" :"" // This key is sent only when project is started with startProject
}

element_action

This event is generated when a user takes any action on the Whatfix Mobile AUI configured via the Dashboard.
actionEventType can be close, end_flow, external_link, anchor_click
actionEventValue: Text of the button with which the action is done is null if there is no interaction with the button. This is possible in scenarios where the elements are dismissed by clicking elsewhere.
Validity: Flow or Elements
Event properties:

{
	"projectName" : "" //Name of project in dashboard
	"language" : "ang", //current leap language for this event
	"timestamp" : "2021-03-28T09:26:55Z",
	"eventName" : "element_action",
	"actionEventType" : "", //action name
  "actionEventValue": "", // action value
	"deploymentName" : "", //Name of deployment in dashboard
	"id" : "", // unique id for the event
	"deploymentVersion": "", //version of deployment
	"projectId" :"" // This key is sent only when project is started with startProject
}

leap_sdk_disable

This event is generated when Whatfix Mobile SDK is programmatically disabled i.e., by using LeapAUI.disable()
Validity: Flow or Elements
Event properties:

{
	"projectName" : "", //Name of project in dashboard
	"language" : "ang", //current leap language for this event
	"timestamp" : "2021-03-28T09:26:55Z", 
	"eventName" : "leap_sdk_disable",
	"deploymentName" : "", //Name of deployment in dashboard
	"id" : "", // unique id for the event
	"deploymentVersion": "", //version of deployment
	"projectId" :"" // This key is sent only when project is started with startProject
}

project_termination

This event is generated when the termination frequency matches the configuration in Whatfix Mobile Studio. It is only valid if the project is started through startProject. The configurable termination parameters are:

• After n flow completion (where n is always a valid integer, valid only in case of FLOW)
• At discovery dismiss by user (valid only in case of FLOW)
• At assist dismiss by user (valid only for ELEMENT)
• After n sessions (where n is always a valid integer, valid case of FLOW/ELEMENT)
  Validity: Flow or Elements started with startProject
  Event properties:

{
	"projectName" : "", //Name of project in dashboard
	"language": "ang", //current leap language for this event
	"timestamp" : "2021-03-28T09:26:55Z", //GMT Timestamp always
	"eventName" : "project_termination",
	"id" : "uuid",
  "terminationRule": "After 5 sessions", //"After 3 flow completion", "At discovery dismiss by user", "At Assist dismiss by user"
	"projectId" :"", // project ID started with startProject
	"deploymentName" : "", // Name of the deployment in dashboard
  "deploymentVersion": "" // version of the deployment
}

Validity table