What is a deep link?
A deep link is a link that navigates to a specific page rather than the homepage. It allows you to direct users straight to a learning activity or theme within the online academy.
If your online academy uses Single sign-on (SSO), users can log in to the online academy using an external account. For SSO, Rakoo uses the SAML protocol. In addition to enabling login via SSO, the SAML protocol also makes it possible to direct users straight to a specific location within the online academy, namely via a deep link.
How do I create a deep link to a learning activity?
You can create a deep link yourself to direct users to a specific learning activity within the online academy.
Here you will find an Excel file with two tabs, where you can paste the correct values. A deep link will be generated automatically. Later in this article, you can read how to find the correct components to create a deep link to a learning activity.
Note!
Make sure the “Log in with "button"" toggle is enabled in the SSO integration.
If this is not enabled, the deep link will not work.
Here's an example of a deep link to a learning activity:
Components
In the example, you'll see three variables listed in the following order:
integrationId =the specific ID of your SSO integration
courseId = the specific ID of your learning activity
context = user or admin
How do I find the correct information for my deep links?
If the SAML integration for your online academy is enabled, you will see a button on the login page with, for example, 'Log in with Microsoft'.
Right-click on 'Log in with Microsoft' and then select 'Copy link.' You now have most of the URL you need. Paste this link into a note, for example, so you can view the URL.
After &courseId=, enter the courseId of the learning activity you want to deep link to. Look up the courseId of the relevant learning activity by opening it via your administrator account. You can find the courseId in the URL, as shown by the highlighted characters in the image below.
After &context=, you will see the context it refers to: either 'user' or 'admin'.
Note!
Make sure that the ID of the learning activity is in the correct place in the link; &courseId=... should be after the integration ID. The link concludes with &context=USER (or ADMIN).
The deep link is now ready to be shared with users!
How do I create a deep link to a theme?
A deep link to a topic is structured in the same way as a deep link to a learning activity. Instead of the courseId, you now use the themeId.
Here you will find an Excel file with two tabs, where you can paste the appropriate values. A deep link will be generated automatically. Later in this article, you can read how to find the correct values to create a deep link to a topic.
Deep linking to a theme only works if the “Discover” feature is enabled for the Library.
Here's an example of a deep link to a theme:
Components
In the example, you'll see three variables listed in the following order:
integrationId =the specific ID of your SSO integration
themeId = the specific ID of the theme
context = user or admin
How do I find the correct information for my deep links?
If the SAML integration for your online academy is enabled, you will see a button on the login page with, for example, 'Log in with Microsoft'.
Right-click on 'Log in with Microsoft' and then select 'Copy link.' You now have most of the URL you need. Paste this link into a note, for example, so you can view the URL.
After &themeId=, you'll insert the themeId of the theme you want to deep link to. Find the themeId of the relevant theme. To do this, open the theme using your administrator account. You'll locate the themeId in the URL, as indicated by the selected characters in the image below.
After &context=, you will see the context it refers to: either 'user' or 'admin'.
Note!
Make sure that the ID of the theme is in the correct place in the link; &themeId=... should be after the integration ID. The link concludes with &context=USER (or ADMIN).