StepsKit developer docs

StepsKit is a tiny embeddable script that plays product tours in your web app. Drop in a script tag, identify your users, and the tours you build in the dashboard show up at the right moment for the right people.

Quickstart

Add this <script> to your site, right before </body>. Replace YOUR_API_KEY with the key from your project's Integrations page.

<script
  src="https://cdn.stepskit.com/stepskit.latest.js"
  data-api-key="YOUR_API_KEY"
  data-user-id="user_123"
  async
></script>

That's it. StepsKit fetches the active tours for your project and decides which (if any) to play based on the rules you set in the dashboard.

Pick a framework

• HTML / Script tag — for server-rendered apps or any site where you can drop a <script> tag.
• React — for Vite, Create React App, or any plain React setup.
• Next.js — uses next/script for optimal loading.

Going deeper

• JavaScript API reference — every method on window.stepskit.
• User attributes — how to pass data about your users so tours can target them.
• Visitor identification — why data-user-id matters and what happens without it.
• Frequency capping — "show once" and how it's enforced.