A URL Parameter action converts a value from a URL parameter within the module's URL into a module variable. This way, information can be passed into the module.
⬇️ Expand for: 💡 URL parameters for beginners
A URL parameter is a component added to the end of a website's address (URL) to provide additional informations or instructions to a web page. It always consists of a key (e.g., q
), and a value (e.g., bryter
), separated by an equals sign ( = ) For example, if we add ?q=bryter
to the end of the website address https://www.google.com/search
, it will display the search result for the term BRYTER.
In the context of a BRYTER module, you can use URL parameters to pass information from the URL into the module. For instance, if you have a published BRYTER module with the URL https://app.bryter.io/s/9CWnQxbBRQW22yc3R36CUQ/request-intake?user_email=support@bryter.io
you can extract the email address support@bryter.io from the URL parameter user_email and use it as a variable within the module, such as for sending an email.
If you wish to include multiple URL parameters in a URL, you can do so by separating them with an ampersand ( & ).
Example: https://app.bryter.io/s/9CWnQxbBRQW22yc3R36CUQ/request-intake?user_email=support@bryter.io&users_department=sales
Use URL Parameter actions in modules
- Create a URL Parameter action to read the value of a URL parameter into your module. In the QUERY PARAMETER NAME field, configure the key that you will add to the URL later.
Avoid using whitespace in the key name.
- Next, choose a TYPE for the variable: text, number, or email. The value of the URL parameter will be converted into a module variable of the selected type. If the format does not match the selected type (e.g., a value with a letter is passed to a number type), the value will be treated as blank.
- Finally, add the URL parameter to your module's URL. There are various ways to do this:
Manual embedding
If you manually embed your module, you will also need to add the key and value for URL parameters manually in the URL.
Pass information from a Redirect Result to a module
You can access a module via a Redirect Result from another module. In this case, ensure that the value in the URL parameter key field of the Redirect Result matches the value in the QUERY PARAMETER NAME field of the URL Parameter action.
Known limitations
- Start parameters are limited to 50 per module.
- URL parameters adhere to browser-specific length limits:
- Chrome and Internet Explorer have a maximum of 2,083 characters,
- Firefox allows up to 65,536 characters, and
- Safari supports 80,000 characters.