All user events pushed to 3rd party platforms are prefixed with
gw_ to easily differentiate GuideWhale from other event sources.Tracked Events
<tracked_event>
Any custom events tracked through the GuideWhale SDK will be pushed to integrated platforms using the same data they have been provided with.Pages
page_viewed
Captured when user visits an untagged page or when a page tag matches the visited page.User identifier.
Company identifier (empty if user isn’t linked to a company).
Tagged page identifier - not set if page is untagged.
Tagged page title - not set if page is untagged.
Newly visited page URL.
Previously visited page URL.
How long user has spent on the previous page. We use this to calculate page view durations.
Event action description.
Features
feature_used
Captured when a tagged feature is used.User identifier.
Company identifier (empty if user isn’t linked to a company).
Tagged feature identifier.
Tagged feature title.
Page URL where feature was used.
Event action description.
Milestones
milestone_completed
Captured when user completes a milestone for the first time.User identifier.
Company identifier (empty if user isn’t linked to a company).
Milestone identifier.
Milestone title at completion.
Page URL where milestone was completed.
Event action description.
Resource Center
resource_center_item_clicked
Captured when user clicks a resource center item.User identifier.
Company identifier (empty if user isn’t linked to a company).
Resource center identifier.
Resource center title.
Resource center published version.
Item identifier.
Item title.
Page URL where user clicked the resource center item.
Event action description.
resource_center_searched
Captured when user searches for help inside the resource center.User identifier.
Company identifier (empty if user isn’t linked to a company).
Resource center identifier.
Resource center title.
Resource center published version.
Help search query.
Page URL where user searched for help.
Event action description.
Guides
guide_viewed
Captured when guide is shown to the user.User identifier.
Company identifier (empty if user isn’t linked to a company).
Guide identifier.
Guide title.
Published guide version number.
Page URL where guide was viewed.
Event action description.
guide_completed
Captured when user reaches the last guide step.User identifier.
Company identifier (empty if user isn’t linked to a company).
Guide identifier.
Guide title.
Published guide version number.
Page URL where guide was completed.
Event action description.
guide_dismissed
Captured when user closes the guide (even after completed).User identifier.
Company identifier (empty if user isn’t linked to a company).
Guide identifier.
Guide title.
Published guide version number.
Page URL where guide was dismissed.
Event action description.
guide_step_completed
Captured when user successfully completes a guide step.User identifier.
Company identifier (empty if user isn’t linked to a company).
Guide identifier.
Guide title.
Published guide version number.
Step identifier.
Step title.
Guide step index, starting with 1.
Page URL where guide step was completed.
Event action description.
Checklists
checklist_viewed
Captured when checklist is shown to the user.User identifier.
Company identifier (empty if user isn’t linked to a company).
Checklist identifier.
Checklist title.
Published checklist version number.
Page URL where checklist was viewed.
Event action description.
checklist_completed
Captured when user completes all checklist tasks.User identifier.
Company identifier (empty if user isn’t linked to a company).
Checklist identifier.
Checklist title.
Published checklist version number.
Page URL where checklist was completed.
Event action description.
checklist_dismissed
Captured when user dismisses the checklist (even after completed).User identifier.
Company identifier (empty if user isn’t linked to a company).
Checklist identifier.
Checklist title.
Published checklist version number.
Page URL where checklist was dismissed.
Event action description.
checklist_task_started
Captured when user starts a checklist task - usually when clicking on it.User identifier.
Company identifier (empty if user isn’t linked to a company).
Checklist identifier.
Checklist title.
Published checklist version number.
Task identifier.
Task title.
Checklist task index, starting with 1.
Page URL where checklist task was started.
Event action description.
checklist_task_completed
Captured when user successfully completes a checklist task.User identifier.
Company identifier (empty if user isn’t linked to a company).
Checklist identifier.
Checklist title.
Published checklist version number.
Task identifier.
Task title.
Checklist task index, starting with 1.
Page URL where checklist task was completed.
Event action description.
Surveys
survey_viewed
Captured when survey is shown to the user.User identifier.
Company identifier (empty if user isn’t linked to a company).
Survey identifier.
Survey title.
Published survey version number.
Page URL where survey was viewed.
Event action description.
survey_completed
Captured when user successfully fills out the survey. For NPS surveys, this is captured immediately after user submits a 0-10 rating.User identifier.
Company identifier (empty if user isn’t linked to a company).
Survey identifier.
Survey title.
Published survey version number.
Page URL where survey was completed.
Event action description.
survey_dismissed
Captured when user dismisses the survey (even after completed).User identifier.
Company identifier (empty if user isn’t linked to a company).
Survey identifier.
Survey title.
Published survey version number.
Page URL where survey was dismissed.
Event action description.
survey_question_answered
Captured when user answers a survey question.User identifier.
Company identifier (empty if user isn’t linked to a company).
Survey identifier.
Survey title.
Published survey version number.
Question identifier.
Question type.
Question title.
User’s response to survey question.
Page URL where survey was dismissed.
Event action description.
Banners
banner_viewed
Captured when banner is shown to the user.User identifier.
Company identifier (empty if user isn’t linked to a company).
Banner identifier.
Banner title.
Published banner version number.
Page URL where banner was viewed.
Event action description.
banner_completed
Captured when banner is successfully shown to the user (typically at the same time asbanner_viewed).
User identifier.
Company identifier (empty if user isn’t linked to a company).
Banner identifier.
Banner title.
Published banner version number.
Page URL where banner was completed.
Event action description.
banner_dismissed
Captured when user dismisses the banner (even after completed).User identifier.
Company identifier (empty if user isn’t linked to a company).
Banner identifier.
Banner title.
Published banner version number.
Page URL where banner was dismissed.
Event action description.
Modals
modal_viewed
Captured when modal is shown to the user.User identifier.
Company identifier (empty if user isn’t linked to a company).
Modal window identifier.
Modal window title.
Published modal window version number.
Page URL where modal window was viewed.
Event action description.
modal_completed
Captured when modal is successfully shown to the user (typically at the same time asmodal_viewed).
User identifier.
Company identifier (empty if user isn’t linked to a company).
Modal window identifier.
Modal window title.
Published modal window version number.
Page URL where modal window was completed.
Event action description.
modal_dismissed
Captured when user dismisses the modal window (even after completed).User identifier.
Company identifier (empty if user isn’t linked to a company).
Modal window identifier.
Modal window title.
Published modal window version number.
Page URL where modal window was dismissed.
Event action description.
Hints
hint_viewed
Captured when hint tooltip is shown to the user. If an element has to be hovered before tooltip is shown, view won’t be captured until tooltip is visible.User identifier.
Company identifier (empty if user isn’t linked to a company).
Hint identifier.
Hint title.
Published hint version number.
Page URL where hint was viewed.
Event action description.
hint_completed
Captured when hint completion condition is met. This can be either when user sees the hint or when the target element is clicked.User identifier.
Company identifier (empty if user isn’t linked to a company).
Hint identifier.
Hint title.
Published hint version number.
Page URL where hint was completed.
Event action description.
hint_dismissed
Captured when user dismisses the hint tooltip (even after completed).User identifier.
Company identifier (empty if user isn’t linked to a company).
Hint identifier.
Hint title.
Published hint version number.
Page URL where hint was dismissed.
Event action description.
Embeddings
embed_viewed
Captured when embedding is shown to the user.User identifier.
Company identifier (empty if user isn’t linked to a company).
Embedding identifier.
Embedding title.
Published embedding version number.
Page URL where embedding was viewed.
Event action description.
embed_completed
Captured when embedding is successfully shown to the user (typically at the same time asembed_viewed).
User identifier.
Company identifier (empty if user isn’t linked to a company).
Embedding identifier.
Embedding title.
Published embedding version number.
Page URL where embedding was completed.
Event action description.
embed_dismissed
Captured when user dismisses the embedding (even after completed).User identifier.
Company identifier (empty if user isn’t linked to a company).
Embedding identifier.
Embedding title.
Published embedding version number.
Page URL where embedding was dismissed.
Event action description.