Query Parameter node
Lets you insert query parameter values from a journey URL into configurable node state properties. This lets you customize journeys based on the query parameter values.
Inputs
This node takes its inputs from the journey URL and maps each query parameter to a property in the node state. For
multi-valued parameters, the node delimits the parameters by a comma (,
) symbol. In this case, the value assigned to
the node state property is a comma-delimited list of items.
The node doesn’t read input from the state.
The node has no required predecessor nodes.
Configuration
Property | Usage | ||
---|---|---|---|
Allowed query parameters |
List the query parameters the node can obtain from the URL and map them to a property in the node state:
If a query parameter in the URL isn’t in this list, the node ignores it. To edit an entry, click its pencil icon (). To remove an entry, click its delete icon (). |
||
Allowed query parameters to be delimited |
Specify the allowed query parameters that can take multiple values and whose values you want to store in the node
state in a comma-delimited list; for example, Enter the query parameter name in the Add value field and click Add. If you don’t delimit the values of a multi-valued query parameter, the node stores the values in the node state as a
single string value; for example, To edit an entry, click its pencil icon (). To remove an entry, click its delete icon (). |
Outputs
-
If the Allowed query parameters setting has one or more values, the node adds the values of the listed URL parameters to the corresponding properties in the node state.
-
If the Allowed query parameters setting has a value, but that query parameter isn’t present in the URL, the node sets an empty list (
[]
) in the corresponding node state property. -
If an allowed query parameter is also listed in the Allowed query parameters to be delimited, the node sets the values of the listed URL parameter in the node state as a comma-delimited list.
|
Errors
-
No parameters configured - this node is redundant
The node logs this error if you include it in a journey but don’t configure any Allowed query parameters.
-
Cannot delimit parameter if it is not configured as a parameter to be stored in node state
The node logs this error if you add a parameter to the list of Allowed query parameters to be delimited but not to the list of Allowed query parameters.
Examples
Use the Query Parameter node to customize a journey based on query parameters in the URL. Consider the following scenarios, for example:
-
Customized branding
An organization has several brands that use the same journey. Use this node to customize the brand the user sees, based on the query parameters.
-
Redirection from an external system
An external system redirects a user to this authentication journey. The external system must share information about the user with the journey. Use this node to obtain the relevant query parameters and inform the journey of their values.