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.string
User identifier.
string
Company identifier (empty if user isn’t linked to a company).
string
Tagged page identifier - not set if page is untagged.
string
Tagged page title - not set if page is untagged.
string
Newly visited page URL.
string
Previously visited page URL.
number
How long user has spent on the previous page. We use this to calculate page view durations.
string
Event action description.
Features
feature_used
Captured when a tagged feature is used.string
User identifier.
string
Company identifier (empty if user isn’t linked to a company).
string
Tagged feature identifier.
string
Tagged feature title.
string
Page URL where feature was used.
string
Event action description.
Milestones
milestone_completed
Captured when user completes a milestone for the first time.string
User identifier.
string
Company identifier (empty if user isn’t linked to a company).
string
Milestone identifier.
string
Milestone title at completion.
string
Page URL where milestone was completed.
string
Event action description.
Resource Center
resource_center_item_clicked
Captured when user clicks a resource center item.string
User identifier.
string
Company identifier (empty if user isn’t linked to a company).
string
Resource center identifier.
string
Resource center title.
number
Resource center published version.
string
Item identifier.
string
Item title.
string
Page URL where user clicked the resource center item.
string
Event action description.
resource_center_searched
Captured when user searches for help inside the resource center.string
User identifier.
string
Company identifier (empty if user isn’t linked to a company).
string
Resource center identifier.
string
Resource center title.
number
Resource center published version.
string
Help search query.
string
Page URL where user searched for help.
string
Event action description.
Guides
guide_viewed
Captured when guide is shown to the user.string
User identifier.
string
Company identifier (empty if user isn’t linked to a company).
string
Guide identifier.
string
Guide title.
number
Published guide version number.
string
Page URL where guide was viewed.
string
Event action description.
guide_completed
Captured when user reaches the last guide step.string
User identifier.
string
Company identifier (empty if user isn’t linked to a company).
string
Guide identifier.
string
Guide title.
number
Published guide version number.
string
Page URL where guide was completed.
string
Event action description.
guide_dismissed
Captured when user closes the guide (even after completed).string
User identifier.
string
Company identifier (empty if user isn’t linked to a company).
string
Guide identifier.
string
Guide title.
number
Published guide version number.
string
Page URL where guide was dismissed.
string
Event action description.
guide_step_completed
Captured when user successfully completes a guide step.string
User identifier.
string
Company identifier (empty if user isn’t linked to a company).
string
Guide identifier.
string
Guide title.
number
Published guide version number.
string
Step identifier.
string
Step title.
number
Guide step index, starting with 1.
string
Page URL where guide step was completed.
string
Event action description.
Checklists
checklist_viewed
Captured when checklist is shown to the user.string
User identifier.
string
Company identifier (empty if user isn’t linked to a company).
string
Checklist identifier.
string
Checklist title.
number
Published checklist version number.
string
Page URL where checklist was viewed.
string
Event action description.
checklist_completed
Captured when user completes all checklist tasks.string
User identifier.
string
Company identifier (empty if user isn’t linked to a company).
string
Checklist identifier.
string
Checklist title.
number
Published checklist version number.
string
Page URL where checklist was completed.
string
Event action description.
checklist_dismissed
Captured when user dismisses the checklist (even after completed).string
User identifier.
string
Company identifier (empty if user isn’t linked to a company).
string
Checklist identifier.
string
Checklist title.
number
Published checklist version number.
string
Page URL where checklist was dismissed.
string
Event action description.
checklist_task_started
Captured when user starts a checklist task - usually when clicking on it.string
User identifier.
string
Company identifier (empty if user isn’t linked to a company).
string
Checklist identifier.
string
Checklist title.
number
Published checklist version number.
string
Task identifier.
string
Task title.
number
Checklist task index, starting with 1.
string
Page URL where checklist task was started.
string
Event action description.
checklist_task_completed
Captured when user successfully completes a checklist task.string
User identifier.
string
Company identifier (empty if user isn’t linked to a company).
string
Checklist identifier.
string
Checklist title.
number
Published checklist version number.
string
Task identifier.
string
Task title.
number
Checklist task index, starting with 1.
string
Page URL where checklist task was completed.
string
Event action description.
Surveys
survey_viewed
Captured when survey is shown to the user.string
User identifier.
string
Company identifier (empty if user isn’t linked to a company).
string
Survey identifier.
string
Survey title.
number
Published survey version number.
string
Page URL where survey was viewed.
string
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.string
User identifier.
string
Company identifier (empty if user isn’t linked to a company).
string
Survey identifier.
string
Survey title.
number
Published survey version number.
string
Page URL where survey was completed.
string
Event action description.
survey_dismissed
Captured when user dismisses the survey (even after completed).string
User identifier.
string
Company identifier (empty if user isn’t linked to a company).
string
Survey identifier.
string
Survey title.
number
Published survey version number.
string
Page URL where survey was dismissed.
string
Event action description.
survey_question_answered
Captured when user answers a survey question.string
User identifier.
string
Company identifier (empty if user isn’t linked to a company).
string
Survey identifier.
string
Survey title.
number
Published survey version number.
string
Question identifier.
string
Question type.
string
Question title.
string
User’s response to survey question.
string
Page URL where survey was dismissed.
string
Event action description.
Banners
banner_viewed
Captured when banner is shown to the user.string
User identifier.
string
Company identifier (empty if user isn’t linked to a company).
string
Banner identifier.
string
Banner title.
number
Published banner version number.
string
Page URL where banner was viewed.
string
Event action description.
banner_completed
Captured when banner is successfully shown to the user (typically at the same time asbanner_viewed).
string
User identifier.
string
Company identifier (empty if user isn’t linked to a company).
string
Banner identifier.
string
Banner title.
number
Published banner version number.
string
Page URL where banner was completed.
string
Event action description.
banner_dismissed
Captured when user dismisses the banner (even after completed).string
User identifier.
string
Company identifier (empty if user isn’t linked to a company).
string
Banner identifier.
string
Banner title.
number
Published banner version number.
string
Page URL where banner was dismissed.
string
Event action description.
Modals
modal_viewed
Captured when modal is shown to the user.string
User identifier.
string
Company identifier (empty if user isn’t linked to a company).
string
Modal window identifier.
string
Modal window title.
number
Published modal window version number.
string
Page URL where modal window was viewed.
string
Event action description.
modal_completed
Captured when modal is successfully shown to the user (typically at the same time asmodal_viewed).
string
User identifier.
string
Company identifier (empty if user isn’t linked to a company).
string
Modal window identifier.
string
Modal window title.
number
Published modal window version number.
string
Page URL where modal window was completed.
string
Event action description.
modal_dismissed
Captured when user dismisses the modal window (even after completed).string
User identifier.
string
Company identifier (empty if user isn’t linked to a company).
string
Modal window identifier.
string
Modal window title.
number
Published modal window version number.
string
Page URL where modal window was dismissed.
string
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.string
User identifier.
string
Company identifier (empty if user isn’t linked to a company).
string
Hint identifier.
string
Hint title.
number
Published hint version number.
string
Page URL where hint was viewed.
string
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.string
User identifier.
string
Company identifier (empty if user isn’t linked to a company).
string
Hint identifier.
string
Hint title.
number
Published hint version number.
string
Page URL where hint was completed.
string
Event action description.
hint_dismissed
Captured when user dismisses the hint tooltip (even after completed).string
User identifier.
string
Company identifier (empty if user isn’t linked to a company).
string
Hint identifier.
string
Hint title.
number
Published hint version number.
string
Page URL where hint was dismissed.
string
Event action description.
Embeddings
embed_viewed
Captured when embedding is shown to the user.string
User identifier.
string
Company identifier (empty if user isn’t linked to a company).
string
Embedding identifier.
string
Embedding title.
number
Published embedding version number.
string
Page URL where embedding was viewed.
string
Event action description.
embed_completed
Captured when embedding is successfully shown to the user (typically at the same time asembed_viewed).
string
User identifier.
string
Company identifier (empty if user isn’t linked to a company).
string
Embedding identifier.
string
Embedding title.
number
Published embedding version number.
string
Page URL where embedding was completed.
string
Event action description.
embed_dismissed
Captured when user dismisses the embedding (even after completed).string
User identifier.
string
Company identifier (empty if user isn’t linked to a company).
string
Embedding identifier.
string
Embedding title.
number
Published embedding version number.
string
Page URL where embedding was dismissed.
string
Event action description.