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

# User Events

> List of GuideWhale events pushed to your 3rd party platform integrations.

<Note>All user events pushed to 3rd party platforms are prefixed with `gw_` to easily differentiate GuideWhale from other event sources.</Note>

## 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.

<ResponseField name="user_id" type="string">
  User identifier.
</ResponseField>

<ResponseField name="company_id" type="string">
  Company identifier (empty if user isn't linked to a company).
</ResponseField>

<ResponseField name="page_id" type="string">
  Tagged page identifier - not set if page is untagged.
</ResponseField>

<ResponseField name="title" type="string">
  Tagged page title - not set if page is untagged.
</ResponseField>

<ResponseField name="url" type="string">
  Newly visited page URL.
</ResponseField>

<ResponseField name="url_from" type="string">
  Previously visited page URL.
</ResponseField>

<ResponseField name="previous_engagement_time_ms" type="number">
  How long user has spent on the previous page. We use this to calculate page view durations.
</ResponseField>

<ResponseField name="description" type="string">
  Event action description.
</ResponseField>

[//]: # "### page_closed"

[//]: # "### page_focused"

## Features

### feature\_used

Captured when a tagged feature is used.

<ResponseField name="user_id" type="string">
  User identifier.
</ResponseField>

<ResponseField name="company_id" type="string">
  Company identifier (empty if user isn't linked to a company).
</ResponseField>

<ResponseField name="feature_id" type="string">
  Tagged feature identifier.
</ResponseField>

<ResponseField name="title" type="string">
  Tagged feature title.
</ResponseField>

<ResponseField name="url" type="string">
  Page URL where feature was used.
</ResponseField>

<ResponseField name="description" type="string">
  Event action description.
</ResponseField>

[//]: # "<ResponseField name=\"version\" type=\"number\">"

[//]: # "    Content version."

[//]: # "</ResponseField>"

## Milestones

### milestone\_completed

Captured when user completes a milestone for the first time.

<ResponseField name="user_id" type="string">
  User identifier.
</ResponseField>

<ResponseField name="company_id" type="string">
  Company identifier (empty if user isn't linked to a company).
</ResponseField>

<ResponseField name="milestone_id" type="string">
  Milestone identifier.
</ResponseField>

<ResponseField name="title" type="string">
  Milestone title at completion.
</ResponseField>

<ResponseField name="url" type="string">
  Page URL where milestone was completed.
</ResponseField>

<ResponseField name="description" type="string">
  Event action description.
</ResponseField>

## Resource Center

### resource\_center\_item\_clicked

Captured when user clicks a resource center item.

<ResponseField name="user_id" type="string">
  User identifier.
</ResponseField>

<ResponseField name="company_id" type="string">
  Company identifier (empty if user isn't linked to a company).
</ResponseField>

<ResponseField name="resource_center_id" type="string">
  Resource center identifier.
</ResponseField>

<ResponseField name="resource_center_title" type="string">
  Resource center title.
</ResponseField>

<ResponseField name="version" type="number">
  Resource center published version.
</ResponseField>

<ResponseField name="item_id" type="string">
  Item identifier.
</ResponseField>

<ResponseField name="title" type="string">
  Item title.
</ResponseField>

<ResponseField name="url" type="string">
  Page URL where user clicked the resource center item.
</ResponseField>

<ResponseField name="description" type="string">
  Event action description.
</ResponseField>

### resource\_center\_searched

Captured when user searches for help inside the resource center.

<ResponseField name="user_id" type="string">
  User identifier.
</ResponseField>

<ResponseField name="company_id" type="string">
  Company identifier (empty if user isn't linked to a company).
</ResponseField>

<ResponseField name="resource_center_id" type="string">
  Resource center identifier.
</ResponseField>

<ResponseField name="resource_center_title" type="string">
  Resource center title.
</ResponseField>

<ResponseField name="version" type="number">
  Resource center published version.
</ResponseField>

<ResponseField name="query" type="string">
  Help search query.
</ResponseField>

<ResponseField name="url" type="string">
  Page URL where user searched for help.
</ResponseField>

<ResponseField name="description" type="string">
  Event action description.
</ResponseField>

## Guides

### guide\_viewed

Captured when guide is shown to the user.

<ResponseField name="user_id" type="string">
  User identifier.
</ResponseField>

<ResponseField name="company_id" type="string">
  Company identifier (empty if user isn't linked to a company).
</ResponseField>

<ResponseField name="guide_id" type="string">
  Guide identifier.
</ResponseField>

<ResponseField name="title" type="string">
  Guide title.
</ResponseField>

<ResponseField name="version" type="number">
  Published guide version number.
</ResponseField>

<ResponseField name="url" type="string">
  Page URL where guide was viewed.
</ResponseField>

<ResponseField name="description" type="string">
  Event action description.
</ResponseField>

### guide\_completed

Captured when user reaches the last guide step.

<ResponseField name="user_id" type="string">
  User identifier.
</ResponseField>

<ResponseField name="company_id" type="string">
  Company identifier (empty if user isn't linked to a company).
</ResponseField>

<ResponseField name="guide_id" type="string">
  Guide identifier.
</ResponseField>

<ResponseField name="title" type="string">
  Guide title.
</ResponseField>

<ResponseField name="version" type="number">
  Published guide version number.
</ResponseField>

<ResponseField name="url" type="string">
  Page URL where guide was completed.
</ResponseField>

<ResponseField name="description" type="string">
  Event action description.
</ResponseField>

### guide\_dismissed

Captured when user closes the guide (even after completed).

<ResponseField name="user_id" type="string">
  User identifier.
</ResponseField>

<ResponseField name="company_id" type="string">
  Company identifier (empty if user isn't linked to a company).
</ResponseField>

<ResponseField name="guide_id" type="string">
  Guide identifier.
</ResponseField>

<ResponseField name="title" type="string">
  Guide title.
</ResponseField>

<ResponseField name="version" type="number">
  Published guide version number.
</ResponseField>

<ResponseField name="url" type="string">
  Page URL where guide was dismissed.
</ResponseField>

<ResponseField name="description" type="string">
  Event action description.
</ResponseField>

### guide\_step\_completed

Captured when user successfully completes a guide step.

<ResponseField name="user_id" type="string">
  User identifier.
</ResponseField>

<ResponseField name="company_id" type="string">
  Company identifier (empty if user isn't linked to a company).
</ResponseField>

<ResponseField name="guide_id" type="string">
  Guide identifier.
</ResponseField>

<ResponseField name="guide_title" type="string">
  Guide title.
</ResponseField>

<ResponseField name="version" type="number">
  Published guide version number.
</ResponseField>

<ResponseField name="step_id" type="string">
  Step identifier.
</ResponseField>

<ResponseField name="title" type="string">
  Step title.
</ResponseField>

<ResponseField name="index" type="number">
  Guide step index, starting with 1.
</ResponseField>

<ResponseField name="url" type="string">
  Page URL where guide step was completed.
</ResponseField>

<ResponseField name="description" type="string">
  Event action description.
</ResponseField>

## Checklists

### checklist\_viewed

Captured when checklist is shown to the user.

<ResponseField name="user_id" type="string">
  User identifier.
</ResponseField>

<ResponseField name="company_id" type="string">
  Company identifier (empty if user isn't linked to a company).
</ResponseField>

<ResponseField name="checklist_id" type="string">
  Checklist identifier.
</ResponseField>

<ResponseField name="title" type="string">
  Checklist title.
</ResponseField>

<ResponseField name="version" type="number">
  Published checklist version number.
</ResponseField>

<ResponseField name="url" type="string">
  Page URL where checklist was viewed.
</ResponseField>

<ResponseField name="description" type="string">
  Event action description.
</ResponseField>

### checklist\_completed

Captured when user completes all checklist tasks.

<ResponseField name="user_id" type="string">
  User identifier.
</ResponseField>

<ResponseField name="company_id" type="string">
  Company identifier (empty if user isn't linked to a company).
</ResponseField>

<ResponseField name="checklist_id" type="string">
  Checklist identifier.
</ResponseField>

<ResponseField name="title" type="string">
  Checklist title.
</ResponseField>

<ResponseField name="version" type="number">
  Published checklist version number.
</ResponseField>

<ResponseField name="url" type="string">
  Page URL where checklist was completed.
</ResponseField>

<ResponseField name="description" type="string">
  Event action description.
</ResponseField>

### checklist\_dismissed

Captured when user dismisses the checklist (even after completed).

<ResponseField name="user_id" type="string">
  User identifier.
</ResponseField>

<ResponseField name="company_id" type="string">
  Company identifier (empty if user isn't linked to a company).
</ResponseField>

<ResponseField name="checklist_id" type="string">
  Checklist identifier.
</ResponseField>

<ResponseField name="title" type="string">
  Checklist title.
</ResponseField>

<ResponseField name="version" type="number">
  Published checklist version number.
</ResponseField>

<ResponseField name="url" type="string">
  Page URL where checklist was dismissed.
</ResponseField>

<ResponseField name="description" type="string">
  Event action description.
</ResponseField>

### checklist\_task\_started

Captured when user starts a checklist task - usually when clicking on it.

<ResponseField name="user_id" type="string">
  User identifier.
</ResponseField>

<ResponseField name="company_id" type="string">
  Company identifier (empty if user isn't linked to a company).
</ResponseField>

<ResponseField name="checklist_id" type="string">
  Checklist identifier.
</ResponseField>

<ResponseField name="checklist_title" type="string">
  Checklist title.
</ResponseField>

<ResponseField name="version" type="number">
  Published checklist version number.
</ResponseField>

<ResponseField name="task_id" type="string">
  Task identifier.
</ResponseField>

<ResponseField name="title" type="string">
  Task title.
</ResponseField>

<ResponseField name="index" type="number">
  Checklist task index, starting with 1.
</ResponseField>

<ResponseField name="url" type="string">
  Page URL where checklist task was started.
</ResponseField>

<ResponseField name="description" type="string">
  Event action description.
</ResponseField>

### checklist\_task\_completed

Captured when user successfully completes a checklist task.

<ResponseField name="user_id" type="string">
  User identifier.
</ResponseField>

<ResponseField name="company_id" type="string">
  Company identifier (empty if user isn't linked to a company).
</ResponseField>

<ResponseField name="checklist_id" type="string">
  Checklist identifier.
</ResponseField>

<ResponseField name="checklist_title" type="string">
  Checklist title.
</ResponseField>

<ResponseField name="version" type="number">
  Published checklist version number.
</ResponseField>

<ResponseField name="task_id" type="string">
  Task identifier.
</ResponseField>

<ResponseField name="title" type="string">
  Task title.
</ResponseField>

<ResponseField name="index" type="number">
  Checklist task index, starting with 1.
</ResponseField>

<ResponseField name="url" type="string">
  Page URL where checklist task was completed.
</ResponseField>

<ResponseField name="description" type="string">
  Event action description.
</ResponseField>

## Surveys

### survey\_viewed

Captured when survey is shown to the user.

<ResponseField name="user_id" type="string">
  User identifier.
</ResponseField>

<ResponseField name="company_id" type="string">
  Company identifier (empty if user isn't linked to a company).
</ResponseField>

<ResponseField name="survey_id" type="string">
  Survey identifier.
</ResponseField>

<ResponseField name="title" type="string">
  Survey title.
</ResponseField>

<ResponseField name="version" type="number">
  Published survey version number.
</ResponseField>

<ResponseField name="url" type="string">
  Page URL where survey was viewed.
</ResponseField>

<ResponseField name="description" type="string">
  Event action description.
</ResponseField>

### survey\_completed

Captured when user successfully fills out the survey. For NPS surveys, this is captured immediately after user submits a 0-10 rating.

<ResponseField name="user_id" type="string">
  User identifier.
</ResponseField>

<ResponseField name="company_id" type="string">
  Company identifier (empty if user isn't linked to a company).
</ResponseField>

<ResponseField name="survey_id" type="string">
  Survey identifier.
</ResponseField>

<ResponseField name="title" type="string">
  Survey title.
</ResponseField>

<ResponseField name="version" type="number">
  Published survey version number.
</ResponseField>

<ResponseField name="url" type="string">
  Page URL where survey was completed.
</ResponseField>

<ResponseField name="description" type="string">
  Event action description.
</ResponseField>

### survey\_dismissed

Captured when user dismisses the survey (even after completed).

<ResponseField name="user_id" type="string">
  User identifier.
</ResponseField>

<ResponseField name="company_id" type="string">
  Company identifier (empty if user isn't linked to a company).
</ResponseField>

<ResponseField name="survey_id" type="string">
  Survey identifier.
</ResponseField>

<ResponseField name="title" type="string">
  Survey title.
</ResponseField>

<ResponseField name="version" type="number">
  Published survey version number.
</ResponseField>

<ResponseField name="url" type="string">
  Page URL where survey was dismissed.
</ResponseField>

<ResponseField name="description" type="string">
  Event action description.
</ResponseField>

### survey\_question\_answered

Captured when user answers a survey question.

<ResponseField name="user_id" type="string">
  User identifier.
</ResponseField>

<ResponseField name="company_id" type="string">
  Company identifier (empty if user isn't linked to a company).
</ResponseField>

<ResponseField name="survey_id" type="string">
  Survey identifier.
</ResponseField>

<ResponseField name="survey_title" type="string">
  Survey title.
</ResponseField>

<ResponseField name="version" type="number">
  Published survey version number.
</ResponseField>

<ResponseField name="question_id" type="string">
  Question identifier.
</ResponseField>

<ResponseField name="type" type="string">
  Question type.
</ResponseField>

<ResponseField name="title" type="string">
  Question title.
</ResponseField>

<ResponseField name="response" type="string">
  User's response to survey question.
</ResponseField>

<ResponseField name="url" type="string">
  Page URL where survey was dismissed.
</ResponseField>

<ResponseField name="description" type="string">
  Event action description.
</ResponseField>

## Banners

### banner\_viewed

Captured when banner is shown to the user.

<ResponseField name="user_id" type="string">
  User identifier.
</ResponseField>

<ResponseField name="company_id" type="string">
  Company identifier (empty if user isn't linked to a company).
</ResponseField>

<ResponseField name="banner_id" type="string">
  Banner identifier.
</ResponseField>

<ResponseField name="title" type="string">
  Banner title.
</ResponseField>

<ResponseField name="version" type="number">
  Published banner version number.
</ResponseField>

<ResponseField name="url" type="string">
  Page URL where banner was viewed.
</ResponseField>

<ResponseField name="description" type="string">
  Event action description.
</ResponseField>

### banner\_completed

Captured when banner is successfully shown to the user (typically at the same time as `banner_viewed`).

<ResponseField name="user_id" type="string">
  User identifier.
</ResponseField>

<ResponseField name="company_id" type="string">
  Company identifier (empty if user isn't linked to a company).
</ResponseField>

<ResponseField name="banner_id" type="string">
  Banner identifier.
</ResponseField>

<ResponseField name="title" type="string">
  Banner title.
</ResponseField>

<ResponseField name="version" type="number">
  Published banner version number.
</ResponseField>

<ResponseField name="url" type="string">
  Page URL where banner was completed.
</ResponseField>

<ResponseField name="description" type="string">
  Event action description.
</ResponseField>

### banner\_dismissed

Captured when user dismisses the banner (even after completed).

<ResponseField name="user_id" type="string">
  User identifier.
</ResponseField>

<ResponseField name="company_id" type="string">
  Company identifier (empty if user isn't linked to a company).
</ResponseField>

<ResponseField name="banner_id" type="string">
  Banner identifier.
</ResponseField>

<ResponseField name="title" type="string">
  Banner title.
</ResponseField>

<ResponseField name="version" type="number">
  Published banner version number.
</ResponseField>

<ResponseField name="url" type="string">
  Page URL where banner was dismissed.
</ResponseField>

<ResponseField name="description" type="string">
  Event action description.
</ResponseField>

## Modals

### modal\_viewed

Captured when modal is shown to the user.

<ResponseField name="user_id" type="string">
  User identifier.
</ResponseField>

<ResponseField name="company_id" type="string">
  Company identifier (empty if user isn't linked to a company).
</ResponseField>

<ResponseField name="modal_id" type="string">
  Modal window identifier.
</ResponseField>

<ResponseField name="title" type="string">
  Modal window title.
</ResponseField>

<ResponseField name="version" type="number">
  Published modal window version number.
</ResponseField>

<ResponseField name="url" type="string">
  Page URL where modal window was viewed.
</ResponseField>

<ResponseField name="description" type="string">
  Event action description.
</ResponseField>

### modal\_completed

Captured when modal is successfully shown to the user (typically at the same time as `modal_viewed`).

<ResponseField name="user_id" type="string">
  User identifier.
</ResponseField>

<ResponseField name="company_id" type="string">
  Company identifier (empty if user isn't linked to a company).
</ResponseField>

<ResponseField name="modal_id" type="string">
  Modal window identifier.
</ResponseField>

<ResponseField name="title" type="string">
  Modal window title.
</ResponseField>

<ResponseField name="version" type="number">
  Published modal window version number.
</ResponseField>

<ResponseField name="url" type="string">
  Page URL where modal window was completed.
</ResponseField>

<ResponseField name="description" type="string">
  Event action description.
</ResponseField>

### modal\_dismissed

Captured when user dismisses the modal window (even after completed).

<ResponseField name="user_id" type="string">
  User identifier.
</ResponseField>

<ResponseField name="company_id" type="string">
  Company identifier (empty if user isn't linked to a company).
</ResponseField>

<ResponseField name="modal_id" type="string">
  Modal window identifier.
</ResponseField>

<ResponseField name="title" type="string">
  Modal window title.
</ResponseField>

<ResponseField name="version" type="number">
  Published modal window version number.
</ResponseField>

<ResponseField name="url" type="string">
  Page URL where modal window was dismissed.
</ResponseField>

<ResponseField name="description" type="string">
  Event action description.
</ResponseField>

## 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.

<ResponseField name="user_id" type="string">
  User identifier.
</ResponseField>

<ResponseField name="company_id" type="string">
  Company identifier (empty if user isn't linked to a company).
</ResponseField>

<ResponseField name="hint_id" type="string">
  Hint identifier.
</ResponseField>

<ResponseField name="title" type="string">
  Hint title.
</ResponseField>

<ResponseField name="version" type="number">
  Published hint version number.
</ResponseField>

<ResponseField name="url" type="string">
  Page URL where hint was viewed.
</ResponseField>

<ResponseField name="description" type="string">
  Event action description.
</ResponseField>

### 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.

<ResponseField name="user_id" type="string">
  User identifier.
</ResponseField>

<ResponseField name="company_id" type="string">
  Company identifier (empty if user isn't linked to a company).
</ResponseField>

<ResponseField name="hint_id" type="string">
  Hint identifier.
</ResponseField>

<ResponseField name="title" type="string">
  Hint title.
</ResponseField>

<ResponseField name="version" type="number">
  Published hint version number.
</ResponseField>

<ResponseField name="url" type="string">
  Page URL where hint was completed.
</ResponseField>

<ResponseField name="description" type="string">
  Event action description.
</ResponseField>

### hint\_dismissed

Captured when user dismisses the hint tooltip (even after completed).

<ResponseField name="user_id" type="string">
  User identifier.
</ResponseField>

<ResponseField name="company_id" type="string">
  Company identifier (empty if user isn't linked to a company).
</ResponseField>

<ResponseField name="hint_id" type="string">
  Hint identifier.
</ResponseField>

<ResponseField name="title" type="string">
  Hint title.
</ResponseField>

<ResponseField name="version" type="number">
  Published hint version number.
</ResponseField>

<ResponseField name="url" type="string">
  Page URL where hint was dismissed.
</ResponseField>

<ResponseField name="description" type="string">
  Event action description.
</ResponseField>

## Embeddings

### embed\_viewed

Captured when embedding is shown to the user.

<ResponseField name="user_id" type="string">
  User identifier.
</ResponseField>

<ResponseField name="company_id" type="string">
  Company identifier (empty if user isn't linked to a company).
</ResponseField>

<ResponseField name="embed_id" type="string">
  Embedding identifier.
</ResponseField>

<ResponseField name="title" type="string">
  Embedding title.
</ResponseField>

<ResponseField name="version" type="number">
  Published embedding version number.
</ResponseField>

<ResponseField name="url" type="string">
  Page URL where embedding was viewed.
</ResponseField>

<ResponseField name="description" type="string">
  Event action description.
</ResponseField>

### embed\_completed

Captured when embedding is successfully shown to the user (typically at the same time as `embed_viewed`).

<ResponseField name="user_id" type="string">
  User identifier.
</ResponseField>

<ResponseField name="company_id" type="string">
  Company identifier (empty if user isn't linked to a company).
</ResponseField>

<ResponseField name="embed_id" type="string">
  Embedding identifier.
</ResponseField>

<ResponseField name="title" type="string">
  Embedding title.
</ResponseField>

<ResponseField name="version" type="number">
  Published embedding version number.
</ResponseField>

<ResponseField name="url" type="string">
  Page URL where embedding was completed.
</ResponseField>

<ResponseField name="description" type="string">
  Event action description.
</ResponseField>

### embed\_dismissed

Captured when user dismisses the embedding (even after completed).

<ResponseField name="user_id" type="string">
  User identifier.
</ResponseField>

<ResponseField name="company_id" type="string">
  Company identifier (empty if user isn't linked to a company).
</ResponseField>

<ResponseField name="embed_id" type="string">
  Embedding identifier.
</ResponseField>

<ResponseField name="title" type="string">
  Embedding title.
</ResponseField>

<ResponseField name="version" type="number">
  Published embedding version number.
</ResponseField>

<ResponseField name="url" type="string">
  Page URL where embedding was dismissed.
</ResponseField>

<ResponseField name="description" type="string">
  Event action description.
</ResponseField>
