Parameters

Returns

Example

Notes

Update attributes for the currently identified user

updateUser()

Usertour documention

Learn how to create effective in-app flows to guide users through your product with interactive tours, tooltips, and modals.

Understanding In-App Flows

Get started with Usertour - a powerful platform for building product tours, checklists, and launchers. Follow this guide to integrate Usertour into your application and create your first user experience.

Getting Started

Find answers to frequently asked questions about Usertour's features, requirements, and integration capabilities.

Learn how to create and customize interactive flows with Usertour

Flows

Learn how to create and manage interactive checklists to guide users through your product

Checklists

Learn how to create and customize launchers to highlight features and provide quick access to help

Launchers

Learn how to create and customize surveys to collect user feedback and measure satisfaction

Surveys/NPS

Learn how to trigger flows or checklists automatically or manually in your application

Starting Content

Learn how to automatically navigate users to the right page when they start a flow or checklist, with three different approaches to handle page navigation

Go to page when flow starts

Learn how to effectively use hidden steps in Usertour to create more complex and dynamic user flows while maintaining a clean and organized flow structure.

Hidden Steps

Learn how to delete user data in Usertour, including complete user deletion, resetting individual flow sessions, and dismissing flows for all users.

Deleting user data

Learn how to manage your Usertour content by deleting or duplicating flows, launchers, and checklists.

Delete and duplicate content

Building onboarding is a collaborative effort, and usertour lets you add your team to the same account so you can all work together on building the content.

Team Management

Learn how to manage different environments for development, staging, and production

Environments

Learn how to manage users and create targeted segments for personalized experiences

Users and Segments

Learn how to manage and target users across different organizations in your application

Companies

Learn how to use URL patterns to control when and where your content appears in your application

URL pattern matching

Learn how to track and analyze user engagement with your flows

Flow Analytics

Content Security Policy

Introduction to Usertour.js SDK and its core features

Introduction

Installation

Initialize the Usertour SDK with your environment token

init()

Identify authenticated users with their unique ID and attributes

identify()

Identify anonymous users with automatically generated IDs

identifyAnonymous()

Check if the current user has been identified

isIdentified()

Clear the current user's identification and hide active flows

reset()

Associate the current user with a company and update company attributes

group()

Update attributes for the currently associated company

updateGroup()

Programmatically trigger and display Usertour content for authenticated users

start()

Check if a specific Usertour content has been started

isStarted()

Close all active Usertour content displays for the current user

endAll()

Set the base z-index for Usertour floating elements

setBaseZIndex()

Understand general concepts, response codes, and authentication strategies.

Troubleshoot problems with this comprehensive breakdown of all error codes.

Errors

All top-level API resources that support listing use the same format for pagination and the same response object.

Pagination

Some top-level API resources that support listing can be ordered by one or more fields using the orderBy query parameter. Each resource will list which fields it can be ordered by.

Ordering

Learn how to expand related objects in API responses using the ```expand``` query parameter.

Expanding objects

Objects in the API, such as users, companies, and events, can store custom attributes in the ```attributes``` object. This allows you to extend the default data model with your own fields.

Attributes

The user object

Upsert a user

Retrieves a specific user by their ID, including all their attributes and relationships.

Get a user

Delete a user

Retrieve a paginated list of users. You can filter the results using various query parameters.

List users

Companies represent organizational units in your system. They can be used to group users, manage permissions, and orchestrate user flows based on company-specific conditions.

The company object

Create a new company or update an existing one. This endpoint uses an upsert operation, creating a new company if the ID doesn't exist, or updating the existing company if it does.

Upsert a company

Retrieve detailed information about a specific company. The endpoint returns a 404 Not Found response if the company does not exist.

Get a company

Permanently remove a company from the system. This operation cannot be undone, and all associated memberships will be deleted.

Delete a company

Retrieve a paginated list of companies in your account. The response includes company details and pagination information.

List companies

Company memberships represent the relationship between users and companies. They allow you to store custom attributes that describe how a user interacts with a specific company.

The company membership object

Create or update a company membership. Note that memberships are managed through user operations rather than direct API calls.

Upsert a membership

Removes a single user from a single company. Leaves the user and the company themselves intact.

Remove a membership

Retrieve company memberships by expanding the memberships field of a user or company object. Direct listing of memberships is not supported.

List memberships

The content object

Retrieves a single content object by its ID.

Get a content

Retrieves a paginated list of all content objects in your account.

List content

The content version object

The question object

Retrieves a specific version of a content object by its version ID.

Get a content version

Retrieves a paginated list of versions for a specific content object.

List content versions

The content session object

The answer object

Retrieves a specific content session by its ID, including all its attributes and relationships.

Get a content session

Permanently deletes a content session and all its associated data (progress, survey answers, etc.). This operation cannot be undone. The API is idempotent - attempting to delete a non-existent session will return a success response.

Delete a content session

Marks a content session as completed and records its completion time. This operation is idempotent - calling it multiple times on the same session will not cause any issues.

End a content session

Retrieves a paginated list of content sessions with optional filtering and expansion options.

List content sessions

The event definition object

Retrieves a paginated list of event definitions in your account. Each definition includes its name, code, and metadata.

List event definitions

The attribute definition object

Retrieves a paginated list of attribute definitions in your account. Each definition includes its data type, scope, and metadata.

List attribute definitions

Environment Variables

Deploy Usertour on your own infrastructure using Docker

Self Hosting

Install and configure Usertour.js in your self-hosted environment

Usertour.js Installation

Set up and run Usertour in your local development environment

Local Development

Usertour is a open-source user onboarding platform, you can build in-app product tours, checklists, and launchers in minutes— effortlessly and with full control.

Why Usertour

Usertour is a no-code platform for building product tours. With Usertour, you can independently create product tours with minimal assistance from developers, allowing you to swiftly enhance the product onboarding experience.

Creating Your First Flow

Learn how Usertour allows you to start flows in various ways

How to start flows

This page introduce the checklists of Usertour .

This page introduce the launchers of Usertour .

This page lists the basics of Usertour flow builder.

This page introduce the companies of Usertour .

Usertour supports an easy-to-use, yet powerful URL pattern for matching pages in your app. URL pattern matching is useful when auto-starting onboarding flows or product tours, progressing to the next step, or marking a checklist task as completed.

Usertour.js Reference

Setup

Users

Companies

Content

Advanced usage

updateUser()

Parameters

Returns

Example

Notes

Usertour.js Reference

Setup

Users

Companies

Content

Advanced usage

​Parameters

​Returns

​Example

​Notes

Parameters

Returns

Example

Notes