Skip to content

Trend Insights

List of Whatfix-related Events

An Event is defined as an end-user interaction and contains contextual information to understand user behavior in an application. There are two types of events in Whatfix:

  • Guidance or Default event
  • App or Custom event

Guidance events**:** All events generated for Whatfix Content and widget interaction. App events**:** User-defined events such as User Actions, events captured using Whatfix API, and more.

  • Whatfix events, both Guidance and App events, appear in the dropdown only after you perform them at least once.

When you create an Insight, view additional details to evaluate an event before you select it. Search for a user action, then hover over it to view details such as Live since, Last interaction, and Used in. Select the user action to view a screenshot with the relevant element highlighted. Application_page_view.png

Expand the accordion to view a list of all the Whatfix-related events captured and their descriptions:

Guidance (Default) events - Others

Event nameDescription
Any Whatfix EventsShows the overall end user engagement with any Whatfix content such as Flows, Beacons, Smart Tips, and more.
Whatfix for Web LoadedTriggered when any Whatfix content or widgets load on a specific page where the end user is active. For example, when a Beacon loads on your application, Whatfix tracks this event.

Flow

Event nameDescription
Flow startedTriggered when the end user launches a Flow from Self Help or Task List.
Flow step shownTriggered when a Flow step is shown to the end user.
Flow step completedTriggered when the end user completes a Flow step.
Flow backtracked 1 stepTriggered when the end user moves a step back in a Flow.
Flow backtracked 1 step and failedTriggered when the end user moves a step back in a Flow and the Flow fails.
Automated Flow stoppedTriggered when a Flow is stopped using the _wfx_close_live() function from the console.
Branched Flow startedTriggered when the end user launches a branched Flow.
Failed to launch flow stepTriggered when the Flow step fails to appear on an application.
Flow Step (automated) ClosedTriggered when an automated Flow step is closed.
Flow closedTriggered when the end user closes a Flow.
Flow closed without feedbackTriggered when flow is abandoned midway and the user does not give feedback.
Flow closed with feedbackTriggered when flow is abandoned midway and the user gives feedback.
Flow completedTriggered when the end user completes a Flow.
Flow Completed with FeedbackTriggered when the end user completes a Flow and gives feedback from the Flow closure feedback message. The Flow closure feedback message appears only if youโ€™ve enabled the Flow closure feedback feature. For more information, see Flow Closure Feedback.
Flow completed without feedbackTriggered when the end user closes a Flow and does not provide feedback from the Flow closure feedback message. The Flow closure feedback message appears only if youโ€™ve enabled the Flow closure feedback feature. For more information, see Flow Closure Feedback.
Flow resumedTriggered when the end user moves forward in a Flow.
Flow switch to manualTriggered when an Automated Flow fails and the Flow is switched to manual for the end userโ€™s inputs.
Flow slideshow closedTriggered when the end user closes a Flow slideshow without completing it. The step number at which the user closed the slideshow is also captured.
Flow slideshow closed at Step 1Triggered when the end user closes a Flow slideshow on the first slide.
Flow slideshow completedTriggered when the end user completes a Flow slideshow.
Flow slideshow restartedTriggered when the end user restarts a Flow slideshow from the last slide. > [!NOTE] > Info: > > A Flow is played as a Slideshow in Self Help and Task List when it is tagged with the nolive tag.
Flow slideshow startedTriggered when the end user starts a Flow slideshow. > [!NOTE] > Info: > > A Flow is played as a Slideshow in Self Help and Task List when it is tagged with the nolive tag.
Flow step viewed in slideshowTriggered when the end user moves through the slides (Flow steps) in a slideshow.
User transitioned to another flowTriggered when the end user navigates to another Flow from the first one.
Attached flow startedTriggered when two Flows are linked and the end user launches the second Flow from the end message pop-up of the first Flow.
Flow end message closed by โ€œXโ€ iconTriggered when the end user closes the Flow end message using the X icon.
Flow end message closed by close buttonTriggered when the end user clicks the Close button on the Flow end message when the feedback option is not configured.
Flow launched as pop-upTriggered when a popup is rendered from where user can start Flow > [!NOTE] > Info: > > When a Flow is tagged with the wfx_play_as_popup tag, a Pop-up is shown before the Flow starts playing.
Flow Shown as Pop-UpTriggered when a Flow is displayed as popup on the application. > [!NOTE] > Info: > > When a Flow is tagged with the wfx_play_as_popup tag, a Pop-up is shown before the Flow starts playing.
Flow with wfx_play_as_popup tag skippedTriggered when the end user skips a Flow with the wfx_play_as_popup tag. > [!NOTE] > Info: > > When a Flow is tagged with the wfx_play_as_popup tag, a Pop-up is shown before the Flow starts playing.
Likert Scale Feedback ResponsesTriggered when end users provide feedback on the helpfulness of a Flow using a 5-point scale or input comments in text format.

Beacon

Event nameDescription
Beacon clickedTriggered when the end user clicks a Beacon on the application.
Beacon ShownTriggered when a Beacon is shown on the application.
Beacon HoveredTriggered when the end user hovers over a Beacon on the application.

Blocker

Event nameDescription
Blocker ShownTriggered when Blocker is shown on the application.
Blocker clickedTriggered when the end user clicks a Blocker on the application.
Blocker hoverTriggered when the end user hovers over a Blocker on the application.

Pop-up

Event nameDescription
Popup ShownTriggered when Pop-up is shown on the application
Pop-up closed by close buttonTriggered when the end user closes the Pop-up using a button configured with the Close action.
Pop-up closedTriggered when the end user closes the pop-up configured using wfx_play_as_popup, which appears before a Flow starts.
Pop-up closed by โ€œXโ€ iconTriggered when the end user closes a Pop-up using the X icon. > [!WARNING] > Note > > If end users close a Pop-up by pressing the Escape key on the keyboard, engagement data is captured using the Pop-up closed by โ€œXโ€ icon event.
Pop-up skippedTriggered when the end user skips the Pop-up.
โ€œDo not show me againโ€ selectedTriggered when the end user selects the Donโ€™t show me again checkbox in a Pop-up.
URL Triggered via Pop-upTriggered when the end user opens the link attached to a Pop-up.
Flow launched from Pop-upTriggered when a popup is rendered from where user can start Flow.
Pop-up carousel slides shownTriggered when a carousel Pop-up slide is shown to end users.

QuickRead

Event nameDescription
QuickRead feedbackTriggered when an end user provides feedback on a QuickRead response for a search query by clicking the Thumbs up option.
QuickRead Links ConsumedTriggered when QuickRead links are accessed by the end user within the QuickRead response.
QuickRead responseTriggered when a QuickRead response or an error message is displayed for a search query.
QuickRead subject feedbackTriggered when an end user clicks the Thumbs down option on a QuickRead response and submits feedback using the How can we improve? field. End users can provide detailed insights about their experience and issues with the QuickRead answer.
QuickRead onboarding "Show me" clickedTriggered when end user clicks on the Show me button when the QuickRead onboarding experience is shown to the end user

Smart Tip

Event nameDescription
Smart tip shownTriggered when the Smart Tip appears on the application.
Smart-tip autocompletedTriggered when the Smart Tip is autocompleted.
Smart-tip autocompleted via scrollTriggered when the Smart Tip is autocompleted when the end user scrolls away and then back to the selected element.
Smart-tip element not foundTriggered when Whatfix is unable to find the element on which the Smart Tip is latched to.
Smart-tip loaded for pageTriggered when the Smart Tip loads on the application. > [!NOTE] > Info: > > Whatfix enables you to filter up to 3 months of data for the Smart-tip loaded for page event.
User closed Smart TipTriggered when the end user closes the Smart Tip using the X icon.
Validation Tip correct inputTriggered when the end user enters the correct input after a Validation Tip is shown.
Validation Tip error fixedTriggered when user fulfills the input criteria for a validation tip
Validation Tip error shownTriggered when input provided by the end user is incorrect and a Validation Tip is shown.

Launcher

Event nameDescription
Launcher ClickedTriggered when the end user clicks a Launcher.
Launcher ShownTriggered when a Launcher gets displayed on the application page

Cues

Event nameDescription
Cue clickedTriggered when user clicks any cue button.
Cue ShownTriggered when Cue is shown on the application.
Cue closedTriggered when user closes a cue using the close button.
Selected Snooze Option in CueTriggered when user selects a snooze option in a cue.

Task List

Event nameDescription
Task List ShownTriggered when a Task List gets displayed on the application page
Task List closedTriggered when the end user closes the Task List.
Task List OpenedTriggered when the end user opens the Task List.
Task List shown after nudgeTriggered when the Task List opens on the application to nudge users.
Task completionTriggered when the end user completes a task in the Task List, based on the completion criteria of the content.
Task list segment completionTriggered when the end user completes all the tasks in the Task List.

Self Help

Event nameDescription
Self Help ShownTriggered when an Old Self Help gets displayed on the application page. > [!NOTE] > Info: > > Whatfix enables you to filter up to 3 months of data for the Self Help shown event.
Self Help OpenedTriggered when the end user clicks the Self Help icon to open the widget.
Self Help closedTriggered when the end user closes Self Help.
Self Help SearchTriggered when the end user engages with Self Help search.
Self Help feedback enteredTriggered when the end user types feedback after searching and not finding results.
Self Help feedback option selectedTriggered when the end user selects the feedback option in the closed or open state of Self Help.
Feedback sent after no search resultTriggered when the end user gives feedback after no search results are found in Self Help.
Email provided for Self Help feedbackTriggered when the end user provides an email address in the feedback in Self Help.
New content notification badge selectedTriggered when the end user selects the new content notification badge in the closed state of Self Help.
New content notification badge hoveredTriggered when the end user hovers the cursor over the new content notification badge in the closed state of Self Help.

Hub

The Self Help (New) event group is now called Hub. Hub contains all Self Help (New) events, such as Icon Shown, Explorer and QuickRead events.

Event nameDescription
Clicks on Self Help (New) icon of PinTriggered when the end user clicks the Pin icon.
Clicks on Explorer icon within the Pin on roll overTriggered when the end user clicks the Explorer icon within the Pin on roll over.
Click on Feedback icon on Pin on roll overTriggered when the end user clicks the Feedback icon within the Pin on roll over.
Clicks on Chatbot icon on Pin on roll overTriggered when end user clicks on the Chatbot icon within the Pin on roll over
Clicks on the Explorer icon in the top navigation barTriggered when the end user clicks the Explorer icon in the top navigation bar of the Self Help (New) widget.
Clicks on the Feedback icon in the top navigation barTriggered when the end user clicks the Feedback icon in the top navigation bar of the Self Help (New) widget.
Clicks on options within no search results screenTriggered when the end user clicks any available option on the no search results screen within the Explorer of Self Help (New). These options include Provide feedback, Send email, and more.
Clicks on the Chatbot icon in the top navigation barTriggered when the end user clicks the Chatbot icon in the top navigation bar of the Self Help (New) widget.
No search results feedbackTriggered when the end user clicks Submit in the Provide feedback option on the no search results screen.
Clicks on content within ExplorerTriggered when the end user consumes any content within the Explorer.
Self Help (New) ExplorerTriggered when a search is initiated within the Explorer of Self Help (New).
Search suggestions shownTriggered when the end user is shown the search suggestions within the Explorer of Self Help (New).
Search filters appliedTriggered when the end user clicks the Apply filter button within the Explorer of Self Help (New). Users can filter search results by content such as Flow, Link, Video, and more. This event helps you understand how many users use the filter option to narrow down search results.
Self Help Icon ShownTriggered when a New Self Help Icon gets displayed on the application page.
Feedback from end usersTriggered when the end user submits feedback by clicking Submit in the Provide feedback option on the no search results screen within the Explorer of Self Help (New).
QuickRead feedbackQuickRead feedback by the end user to the QuickRead response provided for a search query
QuickRead subject feedbackTriggered when end user gives a subjective feedback for QuickRead
QuickRead links consumedQuickRead links accessed by end user within the QuickRead response shown
Self Help (New) QuickRead responseTriggered when QuickRead response / error message is shown
FAB TaskList ClickedUser clicked on the TaskList option in the FAB
Hub > Task List ClickedUser clicked on Task List tab in Hub
TaskList OpenedTriggered when the TaskList Web feature is opened in the HUB application
All Filter ClickedTriggered when the All filter pill is clicked in TaskList Web
All Filter OpenedTriggered when the All filter view is opened in TaskList Web
Complete Filter ClickedTriggered when the Complete filter pill is clicked in TaskList Web
Complete Filter OpenedTriggered when the Complete filter view is opened in TaskList Web
To Do Filter ClickedTriggered when the To Do filter pill is clicked in TaskList Web
To Do Filter OpenedTriggered when the To Do filter view is opened in TaskList Web
Group ClickedTriggered when a group is clicked in TaskList Web to expand/collapse content

Static Content

Event nameDescription
Link openedTriggered when the end user opens a hyperlink from a Smart Tip, Beacon, or Flow step.
Link opened in new formatTriggered when the end user opens a link content created using the Whatfix dashboard or Studio from Self Help, Task List, or Launcher.
Article closedTriggered when the end user closes text content.
Article viewedTriggered when the end user views text content.
IMAGE_STARTTriggered when the end user views an image.
Pdf ViewedTriggered when the end user opens a PDF (except from new Self Help)
Video link clickedTriggered when the end user opens a video link.

Survey

Event nameDescription
Survey ShownTriggered when a Survey gets displayed on the application page
Survey AbandonedTriggered when the end user abandons the Survey.
Survey Confirmation CloseTriggered when survey confirmation dialog is closed after survey submission
Survey MaximizeTriggered when the end user maximizes the Survey.
Survey MinimizeTriggered when the end user minimizes the Survey.
Survey RefreshTriggered when the Survey is refreshed.
Survey SubmitTriggered when the end user submits a Survey.

Extension

Event nameDescription
Extension updatedTriggered when an extension is updated on the end usersโ€™ browsers.

App (Custom) events

Event nameDescription
Any App EventsShows the overall end-user engagement with the created User Actions, events captured using Whatfix API and more.

An event is usually a single event, which is triggered every time a user interacts with any Whatfix content.

Guidance events include all events triggered when end users interact with Whatfix content or widgets within the application.

Whatfix Content includes Flows, Images, Videos, PDFs, Articles and Links.

App events include engagement with User Actions, Autocaptured events (Beta), or events captured using the Whatfix API.

Pin is the interactive icon from where you can expand the new Self Help widget and access its different components: Explorer, and Feedback.

A component that displays a collection of Whatfix content, selected by content creators, to end users.

Feedback is a component that enables end users to share their thoughts about your help content or the underlying application.