Querystring variables
Query parameters are appended to your FlowIframeEmbed Site URL (iframe src). The Visualforce page reads them and starts the flow in Lightning Runtime.
Reserved parameters
Section titled “Reserved parameters”| Parameter | Required | Description |
|---|---|---|
flow | Yes | Flow API Developer Name (for example Check_In_Dispatch). |
endUrl | No | Absolute URL. When flow status is FINISHED, the parent window navigates here. |
inputVars | No | Comma-separated allowlist of param names to pass into flow as String inputs. If omitted, no URL params are passed. |
Flow input parameters
Section titled “Flow input parameters”Any other query parameter is passed to the flow only if its name appears in inputVars.
Example:
https://your-site.force.com/site-prefix/FlowIframeEmbed?flow=New_Customer_Flow&inputVars=recordId,source&recordId=001xxx&source=homepage&debug=1recordIdandsourceare passed.debugis ignored (not ininputVars).
Flow input variable API names must match parameter names case-sensitively.
Using the JavaScript widget
Section titled “Using the JavaScript widget”Set inputVars and params on window.tlFlowEmbed:
window.tlFlowEmbed = { embedUrl: 'https://your-site.force.com/site-prefix/FlowIframeEmbed', flow: 'New_Customer_Flow', inputVars: ['recordId', 'source'], params: { recordId: '001xxx', source: 'homepage' }};Security note
Section titled “Security note”The allowlist prevents arbitrary query params from becoming flow inputs. Validate values in Flow or Apex before using them.
Legacy behavior
Section titled “Legacy behavior”Older widget behavior appended all parent query params into iframe URL. That behavior is not supported on FlowIframeEmbed. List each input explicitly in inputVars.