This guide explains how to customize your program to send specific customers to different websites after they verify successfully. By using dynamic redirect URLs, you can control the customer journey and create unique paths for multiple groups of users.
Understanding dynamic redirects
Dynamic redirects give you control over where users go when they click the Success redirect button. By default in the program builder, users can only be redirected to one place. However, using dynamic redirect URLs allows you to send certain users to different places upon success.
Feature requirements
This feature is available on any program that uses the SheerID hosted Success Page and/or Success email. If you aren't sure if this would be applicable to your program, reach out to Product Support.
Please note that the SheerID team must enable this for you. If you are working with our Professional Services team, please reach out to your Project Manager. If you are not currently engaged with Professional Services, please contact Product Support to enable.
If you are building a new program in My.SheerID, these steps can be completed in order once the changes have been made on the SheerID side. If your program is currently active, you will need to work with Product Support or your Project Manager to take a more phased approach, ensuring there are not interruptions to your consumers.
Once we activate this:
- The Success URL (Redirect) settings card within the Program Builder will be locked, which means you will not be able to make edits to this portion any longer. The locked feature badge will show in the Program Builder settings as "Custom." Any needed changes will need to go through either Professional Services during implementation or Product Support after your program is live.
- If you copy your program, all URLs and settings will copy as well.
Client-side steps
IMPORTANT
You must follow the steps below as they are written. If you skip any part of this process, your dynamic redirect URLs will not work.
Adding a metadata key
You must create a required metadata tracking key on the program so the form knows where to send the user. This also ensures the user is not able to reach the form without a destination URL in place. To do this:
-
Select the desired program from the program list page
-
Go to the Settings menu
-
Scroll down until you find the Metadata Tracking card
-
Click Edit, then Add a new key under Required Keys. If you use Optional Keys, the success step on your form may not work as intended
- Name the key exactly redirectUrl. This is in camel case, and is case sensitive
- Double check that you have added this key under Required Keys
-
Click Save
Update your form links
You control where a user goes at the end of the process by changing the link you provide to them to access the verification form. You must add a query string parameter (QSP) to the end of your base verification form URL.
The link should be formatted as follows:
For example, if you are having a single program redirect users in different countries to separate pages, you would format your URLs as seen below:
After you have completed these steps, be sure to test your program flow to make sure that each success link leads where it should.
See our guide to testing your program here: Testing & Launch Readiness
IMPORTANT
It is mandatory that a fully qualified URL -- one that includes the protocol, domain name, and the top-level domain -- is passed in as the redirectUrl value each time the form is loaded. There is no fallback behavior. If a fully qualified URL is not passed into the form every time it is loaded, the program will not load as expected. This URL must be URL encoded.