Whatfix for Mobile | Documentation
Search…
⌃K

Leap Events (Reference)

Leap generates particular events as the end-user interacts with its flows or elements. This guide will help you understand these events and their purpose.
These events are used by Leap to generate insights on your dashboard. Also, you can send these events to third-party platforms via integration or custom code.
There are two broad entities that constitute Leap's in-app engagement platform:
Element: To drive single interaction on any particular screen Flow: To drive multi-interactions across different screens. It contains one or more elements
You can check the below examples to see how events are generated across different types of projects:
We have also put together the definitions of each event below:
flow_start This event is generated in the following scenarios: 1. When a user sees the Start Screen (configured from the dashboard) 2. When a user clicks on the Icon and trigger happens Validity: Flow
This is the initial step in the case of a Flow type project in the dashboard
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
}
deploymentVersion is to know that the project was changed and deployed again.
  • flow_opt_in
    This event is generated when a user opts-in for the Leap Experience. This event will succeedflow_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 Leap Experience. This event will succeed flow_start event.
    This event is generated in the following scenarios:
    1. 1.
      When a user clicks on the dismiss button in the discovery
    2. 2.
      When a user clicks on a cross button in the discovery
    3. 3.
      When a user clicks outside the discovery i.e Popup/BottomUp/Highlight/Tooltip etc.
    4. 4.
      When a user goes to another screen without selecting anything in 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 Leap element. An element may or may not have sound.
Validity: Flow and Elements Event Properties (for Flow):
{
"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 Element):
element_seen is the initial step in the case of an Element type project in the dashboard.
{
"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. In the dashboard, if a step is marked as EXIT FLOW then this event occurs.
    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 on the stop button inside the Leap Icon.
Validity: Flow (because a Flow project Type will have a Leap 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 Leap icon to the cross symbol on the bottom, and then agrees to disable it by clicking on Yes
Validity: Flow (because a Flow project Type will have a Leap 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 for Leap.
    Validity: Flow (because a Flow project Type will have a Leap 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 Leap AUI configured via the dashboard. actionEventType can be close, end_flow, external_link, anchor_click
actionEventValue : Text of the button with which action was taken will be null if there was 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 Leap 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 termination frequency is matching, with the ones configured in the leap editor. This is only valid if the project is started via startProject. The configurable termination parameters are: 1. After n flow completion (where n is always a valid integer, valid only in case of FLOW) 2. At discovery dismiss by user (valid only in case of FLOW) 3. At assist dismiss by user (valid only for ELEMENT) 4. After n sessions (where n is always a valid integer, valid case of FLOW/ELEMENT) For more on starting a project with projectID you can refer this.
    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:
eventName
validity
flow_start
Flow
flow_opt_in
Flow
flow_opt_out
Flow
element_seen
Flow and Element
flow_success
Flow
flow_stop
Flow
flow_disable
Flow
flow_language_change
Flow
element_action
Flow and Element
leap_sdk_disable
Flow and Element
project_termination
Flow and Element
Insights - Previous
Setup Leap Callbacks
Next
Example (Element)
Last modified 1yr ago