Disclaimer: Some content in this article shows details only available with the new course page. As a Superadmin, you can activate the preview of the new course page for your user only, test it, and then activate it for all users. Learn more on the transition to the new course page.
Introduction
On Go.Learn and on the branded mobile app, you can manage and use different types of links to open specific pages. In this article, we will compare the types supported and highlight their similarities and differences to enable you to know which one you should use in different use cases and how to take the best from each type of link.
We will go through the following links:
- Deep links
- Universal link (iOS) / App links (Android)
- Navigation links
Support of Different Types of Links
First of all, let’s clarify whether each type of link is available for the Go.Learn app, for the branded app or for both of them.
| Go.Learn Mobile App | Branded Mobile App | |
|---|---|---|
| Deep Links | ✔ | ✔ |
| Universal Link | X | ✔ |
| Navigation Links | ✔ | ✔ |
Deep Links
Deep links are custom URLs that allow users to open the Go.Learn app or the branded mobile app on a specific screen rather than simply launching the app.
Detailed information about deep links in the dedicated KB article
Deep links structure
They are composed by the golearn:// prefix followed by a target:
golearn://[target]
Supported Deep Links
Pages
| Deep Link | Description |
|---|---|
| golearn://preloginpage | Opens the app and navigates to the Pre-login page, which is the app page in which the user inserts the platform URL. It can be combined with the Domain parameter in order to prefill the platform URL. |
| golearn://loginpage | Opens the app and navigates to the Login page, which is the app page in which the user inserts their username and password (or chooses the SSO method). You can combine the URI with the Domain parameter in order to prefill the platform URL. Alternatively, you can assume that the platform URL is already known to the app. |
| golearn://allchannelspage | Opens the app and navigates to the All Channels built-in page |
| golearn://mychannelpage | Opens the app and navigates to the My Channel built-in page |
| golearn://mycoursespage | Opens the app and navigates to the My Courses and Learning Plans built-in page |
| golearn://catalog | Opens the app and navigates to the Course Catalog built-in page |
| golearn://latestContent | Opens the app and navigates to the Latest Content page |
| golearn://otj/my-checklists | Opens the app and navigates to the My Checklists built-in page |
| golearn://learn | Opens the app and navigates to the mobile app’s home page (the first page in the menu configured in the Mobile App Main Menu tab in the Manage Menus on the desktop platform.) |
|
golearn://my-activities |
Opens the app and navigates to the My Activities built-in page |
Notes on the preloginpage and loginpage deep links:
Please note that when navigating to preloginpage and loginpage, any user currently logged in will be logged out. For example, if a user logged into the app receives an email from his Admin containing the golearn://preloginpage or the golearn://loginpage deep link and clicks on it, they will be logged out and redirected to the Pre-login page, where they will be required to type their credentials again.If no Domain parameter is passed in the deep link and there is no previous platform URL saved in the app status, the app navigates to the Pre-login page.
Note on all the deep links leading to pages:
Each of these URIs can be freely combined with the Domain and Token optional parameters to provide authentication.
Content
Deep links can lead to both formal content (such as courses, sessions, training materials, learning plans and other) and informal content (such as specific informal assets shared by other users and experts, and playlists).
| Deeplink | Description |
|---|---|
| golearn://channels/{channel_id} | Opens the app and navigates to the channel |
| golearn://pages/{page_id} | Opens the app and navigates to the widget custom page |
| golearn://course/{course_id} | Opens the app and navigates to the course |
| golearn://course/{course_id}/session/{session_id} | Opens the app and navigates to the session of the ILT/VILT course |
| golearn://course/{course_id}/sign | Opens the app and navigates to the e-signature authentication step of the course |
| golearn://course/{course_id}/play/{lo_id} | Opens the app and navigates to the training material of the course |
| golearn://lp/{lp_id} | Opens the app and navigates to the learning plan |
| golearn://catalog/{catalog_id} | Opens the app and navigates to the catalog |
| golearn://asset/view/{asset_id} | Opens the app and navigates to the asset |
| golearn://playlist/{playlist_id} | Opens the app and navigates to the playlist |
| golearn://otj/assignments/{checklist_id} | Opens the app and navigates to the observation checklist |
You'll find the channel, page, course ID (etc.) in the address bar of your desktop browser (as an example, the page ID in the following URI is 53: https://lyceum.docebosaas.com/pages/53/my-dashboard).
Please note that if you target any object that a user may not have permission to view, a contextual message appears in a popup (e.g. “You are not allowed to access this course/training material/asset”). Also note that you can only deep link directly to an entire training material, not a specific time marker or page of an asset.
Universal Link
A universal link is a unique URL that allows users to open the branded app on a specific screen. When a user taps on supported https links pointing to your platform, the app automatically launches and navigates to the corresponding page.
These links are referred to as "app links" in the context of Google's Android OS, while the name used by Apple’s iOS is "universal link". In this article, you will find the term “universal link” to refer to this functionality, regardless of the Operating System you are enabling your links for.
Detailed information about universal link and app links in the dedicated KB article
Universal link structure
A universal link is composed of:
- a protocol (https)
- the platform domain (e.g.
domainname.docebosaas.comor your custom domain such aslearn.mycompanyname.com— to accommodate both options we will generally refer to the domain as {domain}) - a route (e.g. pages/ID in the following example):
https://{domain}/pages/11
- If the route is supported and the page with ID=11 exists in the platform {domain}, the branded app (if installed) opens and the user will be redirected to the corresponding page
- If the route is supported and the page with ID=11 does not exist in the platform {domain}, the branded app (if installed) opens and the user will be redirected to the home page
- If the route is not supported (the link points to a page that is not available in the app) the mobile browser opens instead of the branded app. As not all of the areas and pages of the Docebo platform are available in the mobile app, the app is triggered by the universal link only when the user taps on a supported link (meaning that the link points to a page that is available in the app).
Supported Universal Link
Courses
| Link | Description |
|---|---|
| https://{domain}/learn/course/{course_id} | Opens the app and navigates to the course |
| https://{domain}/learn/courses/{course_id}/{course_name} | Opens the app and navigates to the course * |
| https://{domain}/learn/course/view/elearning/{course_id} | Opens the app and navigates to the e-learning course |
| https://{domain}/learn/course/internal/view/elearning/{course_id} | Opens the app and navigates to the e-learning course |
| https://{domain}/learn/course/view/classroom/{course_id} | Opens the app and navigates to the ILT/VILT course |
| https://{domain}/learn/course/{course_id}/play/{training material_id} | Opens the app and navigates to the training material included in a course |
| https://{domain}/learn/courses/{course_id}/{course_name}/sessions/{session_id}/{session_name} | Opens the app and navigates to the session included in an ILT/VILT course * |
| https://{domain}/learn/courses/{course_id}/{course_name}/lessons/{training material_id}/{training material_name} | Opens the app and navigates to the training material included in a course * |
| https://{domain}/learn/courses/{course_id}/{course_name}/lessons/e-signature/sign | Opens the app and navigates to the e-signature authentication step of the course * |
Learning Plans
| Link | Description |
|---|---|
| https://{domain}/learn/lp/{learning plan_id}[/{learning plan_name}] | Opens the app and navigates to the learning plan |
| https://{domain}/learn/learning_plan/view/{learning plan_id}/{learning plan_name} | Opens the app and navigates to the learning plan |
| https://{domain}/learn/learning-plans/{learning plan_id}/{learning plan_name} | Opens the app and navigates to the learning plan * |
| https://{domain}/learn/learning-plans/{learning plan_id}/{learning plan_name}/courses/{course_id}/{course_name} | Opens the app and navigates to the course included in the learning plan * |
| https://{domain}/learn/learning-plans/{learning plan_id}/{learning plan_name}/courses/{course_id}/{course_name}/lessons/{lesson_id}/{lesson_name} | Opens the app and navigates to the training material of the course included in a learning plan * |
| https://{domain}/learn/learning-plans/{learning plan_id}/{learning plan_name}/courses/{course_id}/{course_name}/sessions/{session_id}/{session_name} | Opens the app and navigates to the session of the course included in the learning plan * |
| https://{domain}/learn/learning-plans/{learning plan_id}/{learning plan_name}/courses/{course_id}/{course_name}/sign | Opens the app and navigates to the e-signature authentication step of the course included in a learning plan * |
* links supported only for those who have activated the preview of the new course page
Other
| Link | Description |
|---|---|
| https://{domain}/share/asset/view/{asset_id} | Opens the app and navigates to the asset |
| https://{domain}/learn/catalog/view/{catalog_id}[=filters] | Opens the app and navigates to the catalog. It can be pre-filtered. |
| https://{domain}/share/latestContent | Opens the app and navigates to the Latest Content page |
| https://{domain}/share/asset/view/{asset_id}(slideup:playlist/{playlist_id}) | Opens the app and navigates to the playlist |
| https://{domain}/learn/dashboard/channel/{channel_id} | Opens the app and navigates to the custom channel |
| https://{domain}/legacy/app7020/index.php?r=channels/index | Opens the app and navigates to the All Channels page |
| https://{domain}/learn/dashboard | Opens the app and navigates to the All Channels page |
| https://{domain}/learn/mycourses[=filters] | Opens the app and navigates to the My Courses and Learning Plans page. It can be pre-filtered. |
| https://{domain}/share/myChannel | Opens the app and navigates to the My Channel page |
| https://{domain}/learn/catalog | Opens the app and navigates to the Course Catalog page |
| https://{domain}/pages/{page_id}[/{page_name}] | Opens the app and navigates to the specific page. Supports providing a custom page title. |
| https://{domain}/share/list/coach | Opens the app and navigates to the Questions & Answers page |
| https://{domain}/otj/my-checklists | Opens the app and navigates to the My Checklists page |
| https://{domain}/otj/assignments/{checklist_id} | Opens the app and navigates to the page of a checklist page |
Parameters in square brackets are optional
Each url can be prefixed with the user's custom domain. If an url points to a different domain, it will be treated as a regular external url.
If you target any object that a user may not have permission to view, a contextual message appears in a popup (e.g. “You are not allowed to access this course/training material/asset”).
Navigation Links
They allow users to navigate inside the app. Navigation links are used to redirect the user to content inside the app, such as a course, an asset or a channel.
Navigation Link Structure
Docebo supports two types of navigation links:
- Absolute navigation links (e.g. https://{domain}/pages/11): their structure is identical to the one of universal link
- Relative navigation links (e.g. pages/11)
Relative Navigation Links
They are supported only if the page exists in the domain where the user is logged.
For example, if you are using a custom domain:
- and in your custom domain the page with ID=11 exists, the user will be redirected to the corresponding page
- and in your custom domain the page with ID=11 does not exist, the user will see a message warning that the link is not supported
Where are Navigation Links Supported in the App?
- Inside of a Custom Content Box widget
- Inside of an Image widget
- Inside of the Description field of a course
- Inside of the Description field of a learning plan
Where are Navigation Link Not Supported in the App?
- Inside of a SCORM training material
- Inside of an HTML training material
Supported Navigation Links
The navigation links supported are the same as the universal link, but if you want to use the relative navigation links, you do not need the domain part (e.g. https://{domain}/). Refer to the tables in the Supported Universal Link chapter to see the complete list.