---
title: "Events for Flow Menu"
slug: "events-for-flow-menu"
updated: 2026-08-06T15:37:07Z
published: 2026-08-06T15:37:07Z
canonical: "support.whatfix.com/events-for-flow-menu"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://support.whatfix.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Events for Flow Menu

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. For more information, see [Insights](/mobile/docs/analytics-dashboard).

The following are the events which are generated for the Walkthrough Checklist and Walkthrough Menu:

![flow_menu](https://cdn.document360.io/a268766e-d74d-4619-9613-e2472f809ffb/Images/Documentation/flow_menu.png?sv=2026-02-06&spr=https&st=2026-10-29T13%3A26%3A48Z&se=2026-10-29T14%3A26%3A48Z&sr=c&sp=r&sig=s3C4Gkus9EEb5qFM6fIFSpeH2UXGfVzRA6rgoB6aGTA%3D)

`flow_menu_start` The `flow_menu_start` event occurs when the Flow menu is shown. To group analytics events for the project, use `projectName`.

```
{
  "id": "a711961b-7531-4b5e-b2dc-ae01395fe244",
  "timestamp": "2021-09-06T06:59:26Z",
  "eventName": "flow_menu_start",
  "projectName": "Partner Training", //Flow Menu project name
  "deploymentVersion": "3",
  "language": "ang",
  "deploymentName": "Partner Training"
}
```

---

`flow_opt_in` The `flow_opt_in` event occurs when a user clicks any of the Flow menu titles. To group analytics events for the selected Flow, use `projectName` and `selectedFlow`.

```
{
  "id": "a711961b-7531-4b5e-b2dc-ae01395fe255",
  "timestamp": "2021-09-06T06:59:26Z",
  "eventName": "flow_opt_in",
  "projectName": "Partner Training", //Flow Menu project name
  "selectedFlow": "Create a follow-up task" //Selected flow title
  "deploymentVersion": "3",
  "language": "ang",
  "deploymentName": "Partner Training"
}
```

When a Flow is selected from the menu, the `flow_start` and `flow_opt_in` events for the selected Flow is also generated.

---

`flow_start` event for selected Flow

```
{
  "id": "a711961b-7531-4b5e-b2dc-ae01395fe244",
  "timestamp": "2021-09-06T06:59:26Z",
  "eventName": "flow_start",
  "projectName": "Follow up task", //Selected flow project name
  "deploymentVersion": "3", // Deployment version of the selected flow
  "parentProjectName": "Partner Training", // Parent project name
  "language": "ang",
  "deploymentName": "Follow up task"
}
```

---

`flow_opt_out` If the **overlay** is clicked, the flow menu dismisses, and `flow_opt_out` appears as `eventName`. To group analytics events for the project, use `projectName`.

```
{
  "id": "a711961b-7531-4b5e-b2dc-ae01395fe266",
  "timestamp": "2021-09-06T06:59:26Z",
  "eventName": "flow_opt_out",
  "projectName": "Partner Training", //Flow Menu project name
  "deploymentVersion": "3",
  "language": "ang",
  "deploymentName": "Partner Training"
}
```

---

`element_seen` Track the element using `elementName` in combination with `selectedFlow`. Use `parentProjectName` to track if the Flow was selected through the Flow menu.

```
{
  "id": "f274dbdb-1e7f-4c91-86a7-017df7a0a4a3",
  "timestamp": "2021-07-02T01:19:14Z",
  "eventName": "element_seen",
  "projectName": "Follow up task", //Selected sub-flow project name
  "selectedFlow": "Create a follow-up task" //Selected flow title
  "parentProjectName": "Partner Training", // Parent project name
  "deploymentVersion": "3",
  "language": "ang",
  "pageName": "page 1",
  "elementName": "Step 1",
  "deploymentName": "Follow up task"
}
```

---

`element_action` Whenever a user clicks any configured transition (in the Dashboard, for example, clicking **Next** ), track the interaction of the element by using `actionEventValue`, that is, **Next** (name of the button). Use the combination of `selectedFlow` and `elementName` to identify the element uniquely. Use `parentProjectName` to track if the Flow is selected through the Flow menu.

```
{
  "id": "57c3de8f-cc3c-42bb-9b5c-1170d85e4916",
  "timestamp": "2021-07-02T01:19:20Z",
  "eventName": "element_action",
  "projectName": "Follow up task", //Selected flow project name
  "selectedFlow": "Create a follow-up task" //Selected flow title
  "parentProjectName": "Partner Traning", // Parent project name
  "deploymentVersion": "3",
  "language": "ang",
  "pageName": "page 1",
  "elementName": "Step 1",
  "actionEventType": "close",
  "actionEventValue": "Next",
  "deploymentName": "Follow up task"
}  
```

---

`element_action` (anchor_click) Whenever a user clicks the configured Anchor, track the interaction of the element using `actionEventValue`, that is, `anchor_click`. Use the combination of `selectedFlow`and `elementName` to identify the element uniquely. Use `parentProjectName` to track if the Flow is selected through the Flow menu.

```
{
  "id": "2288274c-3767-4331-ad7b-e96ee057974d",
  "timestamp": "2021-07-02T01:37:12Z",
  "eventName": "element_action",
  "projectName": "Follow up task", //Selected flow project name
  "selectedFlow": "Create a follow-up task" //Selected flow title
  "parentProjectName": "Partner Training", // Parent project name
  "deploymentVersion": "3",
  "language": "ang",
  "pageName": "page 1",
  "elementName": "Step 2",
  "actionEventType": "anchor_click",
  "deploymentName": "Follow up task"
}
```

---

`flow_success` Action taken on any of the last sub-flows. Track the event by using `eventName` as `flow_success` and the event `selectedFlow` gives the selected `flow_title`. Use `parentProjectName` to track if the Flow is selected through the Flow menu.

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

---

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 **STOP** 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.