Embeds

An embed is a link that admits anyone who opens it to a lab, without signing in. Put it on your own site as an iframe, or share the link directly. Each embed has its own name, lab version, access terms and list of admitted end users.

Open the Embeds drawer

1. Open the lab in the editor.
2. Click the Share icon in the header.
3. Click Embeds.

The drawer lists the lab’s embeds in two groups, Active and Inactive. Each row shows the embed’s name, its access terms, and how many end users it has admitted. Click a row to open it.

Create an embed

1. In the Embeds drawer, click New embed.
2. Fill in the form.
3. Click Create embed.

Field	Default	Description
Name		Names this embed in the list so you can tell your embeds apart, e.g. the docs page or a partner portal. End users never see it.
Lab version	The lab’s default branch	Which branch or tag end users play. Every end user admitted through this embed gets that version.
Access window	24 hours	How long one end user keeps access, counted from the moment they open the link. One of 1 hour, 24 hours, 7 days, 30 days. Each end user gets their own window.
Plays per end user	1	How many times one end user may start the lab inside their window. Choose Limited and a number, or Unlimited.
Embed expires	Never	The embed’s own clock. Choose On a date and pick a date to stop the link admitting anyone new after it. End users already admitted keep their access.
Allowed sites	Any site	The sites allowed to embed this lab in an iframe. Add one origin per site, scheme included, e.g. https://docs.example.com. Leave empty to allow any site.

Caution

Anyone who reaches an allowed page can play this lab without signing in. Each play counts toward your team’s session limits. Set Plays per end user and Allowed sites to keep one link from running up your usage.

An origin is the scheme and host with no path. https://docs.example.com is an origin. https://docs.example.com/labs and docs.example.com are not, and the form refuses them.

Place the embed on your site

Open the embed and stay on the Share tab.

• Embed / Kiosk link is the URL end users open. Click Copy link to copy it. You can share this link directly, for example in an email or a chat message.
• Open in a new window opens the link in a new browser tab. This admits you as an end user of the embed, the same as anyone who opens the link.
• The code block below the link is a ready-made iframe snippet. Paste it into your page’s HTML where you want the lab to appear. The snippet sets the iframe size, the sandbox permissions the player needs, and clipboard access.

If you set Allowed sites, the page that holds the iframe must be on one of those origins. The link refuses end users who open it from any other site, and end users who open the bare link with no site at all.

Preview

The Preview at the bottom of the Share tab shows the lab as the embed frames it. The preview opens the lab as you, not as an end user, so it takes no end user spot. Starting the lab in the preview still counts a play against your team’s session limits.

Leaving a lab in an embed

An embedded lab has no page to exit to, so leaving it returns the end user to the lab’s start screen inside the iframe. The end user stays on your page.

• Stop ends the session and shows the start screen.
• If the lab fails to start, the error screen shows Back to start instead of Exit. A failed start does not use up a play.
• If the session cannot be loaded, the screen shows Try again.
• If the session expires, the screen shows Restart the lab. A restart is a new play. If the end user has no plays left or their window has closed, the player shows the refusal message instead. Go to labs does not show in an embed.

From the start screen, Start lab begins a new play, subject to the end user’s plays and access window.

You cannot set a URL for the end user to go to when they leave the lab. The embed also sends no event to your page. You cannot hide Stop.

Manage an embed

Open the embed and click the Settings tab. It shows who created the embed and when, and the current lab version, access window, plays per end user, expiry and allowed sites.

Edit the settings

1. On the Settings tab, click Edit.
2. Change the fields you need.
3. Click Save changes.

Changes to the access window and plays apply to end users admitted from now on. End users already admitted keep their terms. A revoked embed’s lab version cannot be changed.

Rotate the link

Rotating replaces the embed’s link with a new one. Every page that uses the current snippet stops admitting new end users until you update it with the new one. End users already in a lab keep playing.

1. On the Settings tab, click Rotate.
2. Confirm with Rotate.
3. Copy the new link or snippet from the Share tab and update your pages.

Rotate when a link has leaked, or when you want to move a lab off a page without ending access for people who are already in it.

Revoke the embed

Revoking ends the embed for everyone. The link admits nobody new, and every end user admitted through it loses access. This cannot be undone.

1. On the Settings tab, click Revoke.
2. Confirm with Revoke.

The embed moves to the Inactive group. You can still open it to see its settings and its end users.

End users

Open the embed and click the End users tab. The tab label shows the count. Every browser that has opened the link and been admitted is listed here.

Column	Description
End user	A member of your team shows by name, or by email when they have no name. Anyone else shows as Anonymous or End user with a short id.
Admitted	When they first opened the link.
Plays	Plays used, out of their cap. Just the count when unlimited.
Window	Time left in their access window. No end when it has no end time.
Status	Active, Plays spent or Ended.

The header line sums up the list, for example 7 admitted · 4 active · 2 plays spent · 1 ended. The table shows 20 rows at a time. Click View all to see the rest.

Each row has an actions menu with three items.

• Give more plays sets a new play cap for this end user. The dialog shows how many they have used. Use it to let someone whose plays are spent go again.
• Extend access sets when their access ends: in 1 hour, 24 hours or 7 days from now. Use it to let someone back in after their window closed.
• Remove end user ends their access now. They cannot be admitted through this embed again, even if they open the link in the same browser.

Removing an end user does not stop a session that is already running. It stops their next start.