Embed URLs and parameters

Build the address your page loads, and control which experience appears, in which language and variant.

2 min read

Build the address your page loads so it opens exactly the experience you intend. This page is for whoever writes the embed code.

Every embed starts from an experience address in OmniLab Studio and adds parameters to it. The address never changes on its own — if you swap which experience a page shows, you are editing this address.

The address to load

What you wantAddress
A campaign page offering several experienceshttps://experience.example.com/<campaign-public-link>?embedded=1
One specific experience, opened directlyhttps://experience.example.com/<campaign-public-link>?c=<touchpoint-id>&embedded=1
A specific space inside an experiencehttps://experience.example.com/<campaign-public-link>?s=<space-id>&embedded=1

Include embedded=1 when you write the iframe yourself. It tells OmniLab it is running inside someone else's page, which changes how it lays itself out and how it navigates. Leaving it off produces an experience that behaves as though it owns the whole window.

If you use the JavaScript tag, skip it — the tag adds embedded=1 for you when it builds the frame.

Parameters

ParameterControlsNotes
embeddedEmbedded modeSet to 1 for every embed
cWhich touchpoint opensSkip it to land on the campaign page instead
sWhich space opensFor experiences that have spaces
lLanguageLocks the experience to one language instead of following the visitor
vVariantLocks a specific variant of the experience
fciWhich customer is signing inOnly with customer accounts configured — see Pass a known customer into an experience

Set l when the surrounding page is already in one language and you do not want the experience disagreeing with it.

Where the ids come from

The campaign link, touchpoint id, space id, and variant id all come from the campaign in OmniLab Studio. See Touchpoint URLs & slugs for where each one appears.

Test the address on its own first

Open the address in a normal browser tab before you put it in a page. If it does not work standalone, it will not work embedded, and you will spend the debugging time in the wrong place.

On this page