What is a deep link?
A deeplink is a link that navigates directly to a specific page within the academy, instead of the default homepage. This allows you to send users straight to a particular learning activity or theme within the online academy.
You can choose between a regular link or a link that works via Single sign-on (SSO). In addition, you can always decide whether to share the URL with users or generate a QR code that they can scan.
Deeplinks can be created for the following types of learning activities:
E-learning
Exam
File assignment
Learning playlist
Meet-up
Microlearning
Podcast
Summary
How do I create a deep link to a learning activity?
As an administrator, you can create a deeplink through the 'Share' tab of the learning activity.
Direct link
In the 'Direct link' tab, you can generate a link where users log in with their email address and password. You can copy the link using the copy icon. You can also download a QR code that users can scan with their phone.
If the user has the Rakoo app installed on their phone, the app will open automatically, and the user will be taken directly to the correct learning activity inside the app.
Single sign-on link
In the 'Single sign-on link' tab, you can generate a link that allows users to log in via SSO. Simply select your Single sign-on provider, and the SSO link will be generated automatically. You can copy this link using the copy icon. You can also download a QR code that users can scan with their phone.
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.
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).
How deeplinks work on smartphones
When a user opens a deeplink on their smartphone for the first time, they are given the choice between continuing in the browser or opening it in the app. The option they select will also determine how the deeplink opens the next time.
It’s also important to open the deeplink through the browser app, rather than an in-app browser from another app. Deeplinks are best supported in a browser that is up to date.