Assistant link parameters

Question

Accepted Answer

When sharing a link to a specific flow, there are several optional parameters that can be added as GET parameters to the link to configure the behavior of the assistant.

Optional parameters

`deepLink`

string

If specified and the flow contains a matching node, start on the matching node instead of on the flow's Start node.

See Understand deep links for more information on the use cases of deep links and Work with deep links for more information on how to get and use deep links.

https://app.mavenoid.com/org/YOUR-ORG-NAME/product/1234567/s/new?authtoken=ab12cd34ef56ab12cd34&deepLink=eyJhbGciOiJIUzI1NiJ9.eyJpZCI6IjV1d3JsaXpkcW8xcXRtcXAifQ.1OCaonozvmQ68TskfBE0B5ykiKRzoASnQCiYV0i3YhY

`initFormData`

Record

If specified, prepopulates the specified form data keys with the specified values.

See Understand form data - How form data gets set - JavaScript for more information.

Specify as a series of assignments like initFormData[key1]=value1&initFormData[key2]=value2.

https://app.mavenoid.com/org/YOUR-ORG-NAME/product/1234567/s/new?authtoken=ab12cd34ef56ab12cd34&initFormData[range]=A100&initFormData[model]=A152

If your keys or values contain characters that are reserved in the context of a URL such as #, =, ?, etc., percent-encode them before adding them to the URL.

`lang`

string (an ISO language code)

If specified and there is a translation available matching the provided language code, the assistant will display that translation's text. If not specified or there is no matching translation, the assistant will decide which language to use based on what is available and what the user's browser indicates. The user can also override this within the assistant and pick a different language.

https://app.mavenoid.com/org/YOUR-ORG-NAME/product/1234567/s/new?authtoken=ab12cd34ef56ab12cd34&lang=sv

`preansweredKeyValues`

Record

If specified, preanswer any questions whose answers have matching key/value pairs.

See Work with preanswered key/values for more informaiton.

Specify as a list of maps like the following:

[{"key":"range","value":"a100"},{"key":"model","value":"a152"}]

Then URL encode it:

%5B%7B%22key%22%3A%22range%22%2C%22value%22%3A%22a100%22%7D%2C%7B%22key%22%3A%22model%22%2C%22value%22%3A%22a152%22%7D%5D

https://app.mavenoid.com/org/YOUR-ORG-NAME/product/1234567/s/new?authtoken=ab12cd34ef56ab12cd34&preansweredKeyValues=%5B%7B%22key%22%3A%22range%22%2C%22value%22%3A%22a100%22%7D%2C%7B%22key%22%3A%22model%22%2C%22value%22%3A%22a152%22%7D%5D

Administrators & Analysts