For Outset Users
What to give your external panel:
Outset survey link
Instructions for passing metadata into Outset
1. Study link to distribute:
Navigate to Recruit > Recruit on my own
Copy the Shareable Survey Link (e.g., https://api.outset.ai/interviews/public-surveys/abcdefgh12345678/start)
Share this link with the panel to distribute to participants
2. Instructions for passing metadata into Outset- Section 2 of this document:
Oftentimes, panels want to pass in metadata such as participant ID or status ID to track progress.
Or, if you have off-platform screeners and want to pass in data/status collected from this screener, you might want to pass in that information too.
When you pass in information via a URL, you store that information as a “value” that is associated with a metadata variable “a key” see below for a Quick overview of how to append to the end of the survey link using format ?key={value}
Here’s an example URL with variable keys appended: https://api.outset.ai/interviews/public-surveys/abc123/start/?participant-id={participant-id}&customer-type={customer-type}
The variable keys participant-id and customer-type are passed into Outset.
The curly braces { } are placeholders for real, corresponding values that will be passed in per specific participant. So, for one specific participant that has ID: 12345 and customer type: premium, his/her URL will actually look like: https://api.outset.ai/interviews/public-surveys/abc123/start/?participant-id=12345&customer-type=premium
Now, this participant’s metadata of Participant ID and Customer type are successfully recorded in Outset. You will be able to see that data on the Results tab (metadata column), within individual transcripts, or use those categories for analysis.
What your external panel needs to give you:
Redirect URLs (Completion and Termination/Screen-out URLs) to input into Outset
Metadata variables that need to be passed back to the panel through those URLs
When working with a third-party panel, they may use special tracking links—often called Completion URLs and Termination (or Screen-out) URLs—to know whether a participant successfully finished your study or was screened out. These links help the panel record outcomes and ensure participants receive the correct incentives or routing on their end.
1. Ask whether your panel uses Redirect URLs. If yes…
Most panel providers will supply two types of redirect links:
Completion URL: Used when a participant qualifies and fully completes your study. The panel uses this link to mark the participant as a “complete.”
Termination / Screen-out URL: Used when a participant does not qualify based on your screener. This lets the panel log the participant as a “screen-out” rather than a full complete.
If the panel needs participant information passed back to them (such as a participant ID), they will include variable placeholders within these URLs. These placeholders are where Outset will insert the actual values when the participant is redirected back.
Example completion URL with variable “participant-id”: https://yourpanel.com/complete?participant-id={participant-id}
2. Metadata variables
If the panel requires any specific data about the participant to be sent back—such as their unique participant ID—they must tell you:
Which variables they need, and
The exact variable names they expect
These variables should already be included in the Redirect URLs they send you.
Example: panel needs to receive back participant ID to track completion/termination
Variable the panel needs back: participant-id
Completion URL provided by this panel: https://yourpanel.com/complete?participant-id={participant-id}
Important: If your panel requires you to pass a piece of data into Outset, that same variable name must also be used when passing it out (e.g., {participant-id} in = {participant-id} out). More details on this are covered in the panel provider section of your documentation.
3. Inputting Redirect URLs in Outset
Outset has two fields where you will enter the URLs provided by your panel:
Completion URL (for participant who qualified and completed interview):
Navigate to Recruit > Recruit on my own > Completion URL
Paste the panel’s Completion URL into the field
Click Save
Termination/Screen-out URL (for participants who do not qualify for the study):
Go to Screener > Screen-out URL - scroll to bottom of the page
Paste the panel’s Terminational URL into the field
System will autosave
Final steps:
Once both redirect URLs have been entered...
Let your panel provider know the redirects are configured and ready for testing (if testing is part of their standard process).
As participants begin completing or screening out, check the Results tab in Outset to ensure the expected metadata is flowing correctly.
For External Panel Providers
This section explains how to correctly append participant variables to the Outset shareable survey link and what information you must provide to the Outset customer so they can complete setup.
How to append participant variables onto the Outset link
Outset customers will provide you with a Shareable Survey Link for distribution to your participants. If you need to pass participant information into Outset, you can append metadata parameters to this link.
1. Appending variables
Append metadata parameters to the link using format ?key=value
If multiple parameters: add variables with &
Variables should use curly braces { } for dynamic values, such as {participant-id}
Format example:
https://api.outset.ai/interviews/public-surveys/abc123/start/?participant-id={participant-id}&customer-type={customer-type}
2. Placeholder formatting rules:
To ensure Outset can capture metadata correctly…
Placeholders must be in single curly braces { } (not double braces or brackets)
Correct: {participant-id}
Incorrect: {{participant-id}} or [participant-id]
In your communication with our customers, please clearly communicate the exact variable key names you are using so the Outset customer can match against what’s captured in the Outset platform.
What to provide to Outset's customers
Participant metadata parameters -
Variables you want captured in Outset, appended on the survey link (e.g., RID, status ID, other demographic data)Completion URL -
The URL that participants should be redirected to after finishing the interview.Termination (screen-out) URL -
The URL that participants should be directed to if disqualified.
Additional notes
Any variables you append to the survey link must use the same key names when passed back out of Outset (for example, {participant-id} in = {participant-id} out)
Outset does not support multiple sources of recruitment within one study.
Outset supports only two redirect outcomes: Completion and Termination. Any other statuses (e.g., Over Quota) will be recorded as a Termination.
Best Practices for Collaboration
Review: All Steps at a Glance
Outset customer shares the Shareable Survey Link found under Recruit > Recruit on my own with panel provider.
Panel provider shares back the Completion URL and Screen-out URL with Outset customer.
Outset customer adds the Completion URL to Recruit > Recruit on my own.
Outset customer adds the Screen-out URL to Screener > Screen-out URL (at the very bottom of that page).
If time permits, Outset customer and panel provider complete a quick test to confirm data is flowing correctly (usually not necessary if link formats remain consistent).
As responses come in, Outset customer confirms that metadata (if any) is visible for each participant on the Results page > Metadata column.
If metadata is not appearing correctly, feel free to loop in the Outset team for some help with troubleshooting recommendations at [email protected]
If further troubleshooting is needed with the panel, please provide the following information to Outset:
From Outset users:
Relevant workspace (if applicable), project, and study name
confirmation of the dummy participant experience (e.g., were they screened out, did they complete?)
If needed, relevant panel used and main contact from panel
From panel:
A copy of the custom survey link used - this is what the panel is sending out to participants, not the original link provided by Outset!
Variable names passed in & expected out - as well as any dummy metadata passed in
Hope this helps! If you have any further questions, please reach out to our team at [email protected] or via chat.