Top
Events for Static Flow
  • 20 Jun 2024
  • 3 Minutes To Read
  • Dark
    Light
  • PDF

Events for Static Flow

  • Dark
    Light
  • PDF

Article summary

Events are generated whenever a user interacts with any Whatfix Mobile content. These events can then be used to generate Insights about the engagement rate.

The following are the events that are generated when the Static Flow project shown in the following image is run:

static_flow

START

Start_step_static_flow

flow_start
To group analytics events for this project, use projectName.

{
  "id": "8b8bbc83-79bf-4948-beff-75be9df8bcf1",
  "timestamp": "2021-07-02T01:18:56Z",
  "eventName": "flow_start",
  "projectName": "Onboarding flow",
  "deploymentVersion": "3",
  "language": "ang",
  "deploymentName": "Onboarding flow"
}

flow_opt_in or flow_opt_out

flow_opt_in occurs when the user clicks on Take a tour (if opt-in is configured for this button). If the cross or overlay is clicked then you get flow_opt_out as the eventName.

{
  "id": "bf77b357-bb53-4d77-b4f2-3e15820d173d",
  "timestamp": "2021-07-02T01:19:13Z",
  "eventName": "flow_opt_in", //or flow_opt_out
  "projectName": "Onboarding flow",
  "deploymentVersion": "3",
  "language": "ang",
  "deploymentName": "Onboarding flow"
}

STEP 1 (Highlight, if flow_opt_in)

static_flow_highlight

element_seen
Track this element using elementName in combination with projectName.

{
  "id": "f274dbdb-1e7f-4c91-86a7-017df7a0a4a3",
  "timestamp": "2021-07-02T01:19:14Z",
  "eventName": "element_seen",
  "projectName": "Onboarding flow",
  "deploymentVersion": "3",
  "language": "ang",
  "pageName": "page 1",
  "elementName": "Step 1",
  "deploymentName": "Onboarding flow"
}      

element_action
Whenever the user clicks the Next button, track the interaction of this element by using actionEventValue, ie Next (name of the button). Use the combination of projectName and elementName to identify this element uniquely.

{
  "id": "57c3de8f-cc3c-42bb-9b5c-1170d85e4916",
  "timestamp": "2021-07-02T01:19:20Z",
  "eventName": "element_action",
  "projectName": "Onboarding flow",
  "deploymentVersion": "3",
  "language": "ang",
  "pageName": "page 1",
  "elementName": "Step 1",
  "actionEventType": "close",
  "actionEventValue": "Next",
  "deploymentName": "Onboarding flow"
}  

STEP 2 (Tooltip)

static_flow_tooltip

element_seen
Track this element using elementName in combination with projectName.

{
  "id": "aa496d41-ed05-491a-9a45-d22ca306f89c",
  "timestamp": "2021-07-02T01:35:55Z",
  "eventName": "element_seen",
  "projectName": "Onboarding flow",
  "deploymentVersion": "3",
  "language": "ang",
  "pageName": "page 1",
  "elementName": "Step 2",
  "deploymentName": "Onboarding flow"
}      

element_action
Whenever the user clicks the Search icon, track the interaction of this element using actionEventValue i.e. anchor_click. Use the combination of projectName and elementName to identify this element uniquely.

{
  "id": "b1296055-8c18-4717-bf01-cba8337226f5",
  "timestamp": "2021-07-02T01:36:14Z",
  "eventName": "element_action",
  "projectName": "Onboarding flow",
  "deploymentVersion": "3",
  "language": "ang",
  "pageName": "page 1",
  "elementName": "Step 2",
  "actionEventType": "anchor_click",
  "deploymentName": "Onboarding flow"
}

STEP 3 (Tooltip)

static_flow_tooltip_step3

element_seen
Track this element using elementName in combination with projectName.

{
  "id": "66ac23f4-9a85-4134-983f-618a6b24eaa7",
  "timestamp": "2021-07-02T01:36:41Z",
  "eventName": "element_seen",
  "projectName": "Onboarding flow",
  "deploymentVersion": "3",
  "language": "ang",
  "pageName": "page 1",
  "elementName": "Step 3",
  "deploymentName": "Onboarding flow"
}

element_action
Whenever the user clicks the Cart icon, track the interaction of this element using actionEventValue i.e. anchor_click. Use the combination of projectName and elementName to identify this element uniquely.

{
  "id": "2288274c-3767-4331-ad7b-e96ee057974d",
  "timestamp": "2021-07-02T01:37:12Z",
  "eventName": "element_action",
  "projectName": "Onboarding flow",
  "deploymentVersion": "3",
  "language": "ang",
  "pageName": "page 1",
  "elementName": "Step 3",
  "actionEventType": "anchor_click",
  "deploymentName": "Onboarding flow"
}

STEP 4 (Fullscreen)

static_flow_fullscreen

element_seen
Track this element using elementName in combination with projectName.

{
  "id": "723e944a-defa-45e4-8f17-b08f20369b82",
  "timestamp": "2021-07-02T01:37:17Z",
  "eventName": "element_seen",
  "projectName": "Onboarding flow",
  "deploymentVersion": "3",
  "language": "ang",
  "pageName": "page 1",
  "elementName": "Step 4",
  "deploymentName": "Onboarding flow"
}      

element_action
Whenever the user clicks the Next button, track the interaction of this element by using actionEventValue i.e. Awesome! (name of the button). Use the combination of projectName and elementName to identify this element uniquely.

{
  "id": "5aca67c6-6b51-4eb6-b298-788595bbe60b",
  "timestamp": "2021-07-02T01:38:34Z",
  "eventName": "element_action",
  "projectName": "Onboarding flow",
  "deploymentVersion": "3",
  "language": "ang",
  "pageName": "page 1",
  "elementName": "Step 4",
  "actionEventType": "close",
  "actionEventValue": "Awesome!",
  "deploymentName": "Onboarding flow"
}

STEP 4 (flow_success)

You get the flow_success event immediately after the element_action event.

{
  "id": "6691f2be-773c-4dfa-ba74-0bb73898bd51",
  "timestamp": "2021-07-02T01:38:34Z",
  "eventName": "flow_success",
  "projectName": "Onboarding flow",
  "deploymentVersion": "3",
  "language": "ang",
  "deploymentName": "Onboarding flow"
}

Flow Menu

{
  "id": "a711961b-7531-4b5e-b2dc-ae01395fe244",
  "timestamp": "2021-09-06T06:59:26Z",
  "eventName": "flow_success",
  "projectName": "Partner Traning", //Flow Menu project name
  "selectedFlow": "Create a follow-up task" //Selected flow title
  "deploymentVersion": "7",
  "language": "ang",
  "deploymentName": "Partner Traning",
}
your title goes here

You get flow_success in STEP 4 as the last step in a Static Flow is considered as a successful completion of the Flow.

Apart from the mentioned events, you also get the following events:
flow_disable - If a user drags and dismisses the Flow.
flow_stop - If a user stops the Flow by selecting the option on the icon.
flow_language_change - If you have configured a multilingual project, then there are chances that the user might change the language.


Was this article helpful?

Changing your password will log you out immediately. Use the new password to log back in.
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.