Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developers.autoplay.ai/llms.txt

Use this file to discover all available pages before exploring further.

Autoplay streams structured UI actions from your users’ browser sessions in real time. This tutorial wires that stream to Usertour so that when the right moment arrives — a user stuck on a page, a first-time feature visit, a repeated error — your backend detects it and fires the correct Usertour flow immediately. This tutorial builds on How to trigger a User Tour. Complete that guide first — it covers the proxy route, EventSource connection, and payload structure. This page covers only what is specific to Usertour.

​
1. Install Usertour

Add the snippet to your app and initialize it with your environment token from Settings → Environments. 
<script>
  window.usertourjs=window.usertourjs||[];
  !function(){var s=document.createElement("script");
  s.type="text/javascript";s.async=!0;
  s.src="https://js.usertour.io/usertour.js";
  var e=document.getElementsByTagName("script")[0];
  e.parentNode.insertBefore(s,e)}();
</script>
Then initialize the SDK once the script loads: 
usertour.init('YOUR_ENVIRONMENT_TOKEN');

​
2. Identify the user

Call this once the user is authenticated. Use the same userId you send to PostHog so Autoplay can match sessions correctly. 
await usertour.identify(userId, {
  name: user.displayName,
  email: user.email,
  signed_up_at: user.createdAt, // ISO 8601
});

​
3. Create a flow in Usertour

  1. In the Usertour dashboard go to Flows → New flow and build your tour.
Usertour new flow
  1. Use the visual builder to add steps — tooltips, modals, hotspots, or checklists — and attach each step to an element on your page.
Usertour flow builder
  1. Set any targeting rules you need (page URL, user segment, etc.), then publish the flow.
  2. Note the Flow ID shown in the URL bar when editing the flow (/flows/<flow_id>/edit).
Usertour flow ID in URL

​
4. Trigger the flow

In your onmessage handler from Step 4 of the base guide, add the Usertour trigger call: 
events.onmessage = (event) => {
  const payload = JSON.parse(event.data);

  if (payload.type !== "usertour_trigger") return;

  const mySessionId = posthog?.get_session_id?.() ?? null;
  if (!mySessionId || payload.session_id !== mySessionId) return;

  usertour.start(payload.flow_id);
};
The flow_id in the payload maps to the Flow ID of your Usertour flow, visible in the URL when editing the flow in the Usertour dashboard.