Reveal documentation

Documentation

Everything you need to record, publish, and deliver personal video onboarding with Reveal.

Popular

Get started

What Reveal is

Reveal turns a screen recording of you into in-product onboarding your users can actually follow.

Get started

Install Reveal for Chrome

Add the extension, grant three permissions, and confirm the dashboard sees it.

Guides

Edit and re-record

Editing happens in Reveal for Chrome, the dashboard is where you inspect what you recorded.

Guides

Publish, draft, and archive

The three states a guide can be in, the checks to run before you go live, and what archiving keeps.

Guides

Find and organise guides

Tabs, search, filters, and layout options for finding the right guide once you have more than a handful.

Checklists

Checklists

Several guides put in order, so a new user works through them as one journey.

Checklists

Create a checklist

Record the guides first, then bundle them into an ordered journey from the Checklists page.

Delivery

Ways to deliver a guide

The four ways a Reveal guide reaches a user: the pixel, the Reveal button, a dynamic link, and the interactive player.

Delivery

The Reveal button

A drop-in button your users click to start a specific guide, for help menus, empty states, and docs pages.

Delivery

Dynamic links

Add ?reveal={guideId} to any URL on your domain and the guide starts when someone lands there.

Delivery

The interactive player

A chapter-based embed that plays your guide on any page, including pages you don't own.

Behavior

Triggers

The trigger decides when a guide appears. It's the setting that decides whether anyone sees the guide at all.

Behavior

Audience

Decide who is eligible to see a guide, from brand new users to a custom segment.

Behavior

Skips, frequency, and feedback

The Behavior settings that decide how a guide behaves when someone dismisses it, and how often it may come back.

Analytics

Analytics

What Reveal measures, where each number lives, and what to change when one of them looks wrong.

Analytics

The step funnel

See how far users get through a guide, and find the step where they leave.

Analytics

Ratings and feedback

The one tap reaction and optional comment users leave at the end of a guide, and where it surfaces in the app.

Workspace

Workspace settings

Name your workspace, upload a logo, set the URL used in share links, and understand what a workspace holds.

Workspace

Team and roles

Invite teammates by email, choose between Admin and Member, and change someone's role later.

Workspace

Your account

Your profile, password, and two-factor authentication, all of which follow you across every workspace.

Workspace

Notifications

Set your performance digest, pick which events email you, and connect Slack for drop-off and feedback alerts.

Workspace

Integrations

The five planned integrations, what each one will do, and what to use until they ship.

Workspace

Plans and billing

Reveal is free with unlimited guides while it is in beta, and no card is needed until you upgrade.

Workspace

Danger zone

Transfer a workspace, export everything as CSV, delete all guides, or delete the workspace itself.

Developers

Pixel reference

The pixel snippet, its attributes, how domain matching works, and how to verify the install.

Developers

Embed reference

The Reveal button, dynamic links, and the interactive player iframe, with their attributes and parameters.

Developers

Events

What Reveal records as a guide plays, the four named events, and how to get the data out today.

Developers

Identifying users

Why Reveal needs to know who a visitor is, what it will use that for, and what to plan on sending.

Developers

API keys

The one live key per workspace, where to find it, how to rotate it, and how to keep it safe.

Resources

Troubleshooting

The things that most often go wrong with guides, recording, and the pixel, and how to fix each one.

Resources

Glossary

Every term Reveal uses, defined once, in alphabetical order.

Resources

What's coming

Features you'll see referenced in the app that aren't live yet, and what they'll do.

Get started

How Reveal works

The six terms you'll see across the app, and how they fit together.

Get started

Quickstart

Create a guide, record it, install the pixel, and get your first onboarding video live.

Guides

Record a guide

Create the guide, open Reveal for Chrome on your product, and talk through it one step at a time.

Delivery

Install the pixel

Add one script tag to your site and every published guide and checklist in your workspace can run.