Find our recorded webinar on URL Parameters in our Video and Webinar section here to see typical use case examples and how to best use URL Parameters.
What are URL Parameters?
A URL Parameter allows you to get data from the outside environment. When your module is embedded in an intranet solution, it can use data from this solution and place it in the module. For example: You could embed it in an environment like Microsoft Sharepoint or Microsoft Teams and access the name of the account in the module. Note that this an advanced feature and you should be familiar with the concept of URL structure.
How to use URL Parameters
Authors can find the URL Parameter action node under ACTIONS in the Action tab list.
After inserting the URL parameter action - usually at the very top of your graph underneath the START - authors need to define the QUERY PARAMETER NAME. This QUERY PARAMETER NAME equals the parameter in your URL, e.g., https://app.bryter.io/editor/1234?queryparametername=value.
Please note that you can use several URL parameter actions to inject values into a module. The order of the URL parameter actions matters and needs to follow the order of the parameter names in the actual URL. If you want to pass through a database record ID and an email, your URL might look like this: https://app.bryter.io/editor/1234?id=value1&email=value2
Parameter names are case-sensitive, so they have to be an exact match. Look out for so-called "trailing whitespaces", which are often empty spaces that are accidentally added.
Your graph should thus look similar to the below example:
Example use cases
Add personalized user data to your module
When embedding your module on the intranet or in Microsoft Teams in an Iframe, you can access data from outside like the username or E-Mail address. In this case you can directly add this data into the module, so the user does not need to type it manually.
Work with databases
Using URL Parameter allows you to access personalized information from a database. Your module can access an ID from the embedded environment like Microsoft Teams or Microsoft Sharepoint which can be used as a key to get data from a database. Once a user logs into that environment, BRYTER will be able to place all user related data automatically in the module.
Create personalized email campaigns using automation tools
You can use an email marketing automation platform like Mailchimp to send a link to your module which will display personalized data like the user name. In this case use have to append the name placeholder (similar like creating placeholders in Word documents with BRYTER) which will be replaced with the user name by your email marketing automation platform. This workflow is the same for any kind of automation tool.
Transfer data from one BRYTER module to another
Using URL Parameter you could create a link in a BRYTER module which refers to another BRYTER module. You could pass data from one module to the other by appending variables to your URL. The target BRYTER module can use the URL Paramter feature to read this data and display it within the module.
Parameters
[1] Query parameter name
This has to be placed at the end of the URL. In this case "?user_id={user.id}" has to be added to the end of the URL to get an ID from outside which is set by {user.id}
https://app.bryter.io/s/nR_y1hnJT_WtnXIcslfIzA/url_parameters_example?user_id={user.id}
You can also add multiple parameters. Each parameter has to correspond to a separate Node. In this case you would need another Node with the QUERY PARAMETER NAME: user_name
https://app.bryter.io/s/nR_y1hnJT_WtnXIcslfIzA/url_parameters_example?user_id={user.id}&user_name={user.firstname}
[2] Type
Choose whether the value which will be a text, a number or an email. If it is a number type, you can use it in a calculation action. If it is an email type, you can use it in a send email action and a email value.
Behavior on reading numbers
A URL Parameter is also a way to decode numbers from an URL. If you would like to read a currency (e.g. € 49.99), always use the dot and never the comma as a separator. Your URL Parameter should look like "?currency=49.99". If you were to use a comma (e.g. "?currency=49,99") the value would be rejected and a zero will be exposed by the URL Parameter integration, regardless of the language and region of the module.
How to use URL Parameters with secure embedding (Private API)
For advanced security options and better control who has access to your module, you can embed your module via a Private API. Instead of linking the module directly via the URL in an iFrame, you will use the module ID with a dedicated API-key.
In case you are using URL parameter nodes in your module, you can provide these parameters as well by following this approach:
{
auth: {
apiKey: {{api_key}}
}
data: {
parameters: {
companyName: "ACME"
}
}
}