Skip to content

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.

ParameterRequiredDescription
flowYesFlow API Developer Name (for example Check_In_Dispatch).
endUrlNoAbsolute URL. When flow status is FINISHED, the parent window navigates here.
inputVarsNoComma-separated allowlist of param names to pass into flow as String inputs. If omitted, no URL params are passed.

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=1
  • recordId and source are passed.
  • debug is ignored (not in inputVars).

Flow input variable API names must match parameter names case-sensitively.

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' }
};

The allowlist prevents arbitrary query params from becoming flow inputs. Validate values in Flow or Apex before using them.

Older widget behavior appended all parent query params into iframe URL. That behavior is not supported on FlowIframeEmbed. List each input explicitly in inputVars.