Docebo Integration
Docebo is an Learning Management System (LMS) that provides course management, and other features. Many customers use Docebo to manage their courses and have asked about integrating Docebo with our systems. With the newest version of Webhooks and Integrations, we are happy to announce that Worklink can easily integrate with Docebo.
- 1 Use Case
- 2 Step One: Turn on extra data for xAPI/Tin Can
- 3 Step Two: Add Worklink to E-Learning Whitelist
- 4 Step Three: Create Public Key and Secret
- 5 Step Four: Add API Credentials
- 6 Step Five: Create New Integration
- 7 Step Six: Create A Course
- 8 Step Seven: Add Training Material
- 9 Step Eight: Change the Training Material Settings
- 10 Step Nine: Test
Use Case
There are many use cases and ways for Docebo and Worklink to work together but this document will focus on one case in particular:
“As a Docebo user, I want to be able to launch a graded quiz on Worklink from my Docebo course training list and when I have completed and passed my quiz, I want Docebo to display that I have completed the training.”
Step One: Turn on extra data for xAPI/Tin Can
xAPI / Tin Can is a feature within Docebo that will launch external content from Docebo. To use the Worklink integration, you will need to enable extra parameter data to be added to the external URLs that are used to launch training courses. The integration will use these extra parameters to connect the Worklink scenarios to the courses, training materials, and users within Docebo.
To turn on this feature in Docebo, log into your Docebo dashboard as an admin, and go to the Admin Menu by clicking on the gear icon in the top right corner:
Next, scroll down the page to the Settings section and click on Advanced Settings link:
Now, click on the Advanced Options link under the Main Functions menu:
Lastly, scroll down the page and make sure the XAPI/TinCan checkbox is checked:
Now that the additional data for XAPI/TinCan is turned on, we need to whitelist the external URL for Worklink.
Step Two: Add Worklink to E-Learning Whitelist
Now, we need to add Worklink’s getworklink service to Docebo’s xAPI external content whitelist.
What is the getworklink service? This service allows for easy sharing of Worklink scenarios with a getworlink URL. Each scenario within Worklink has a shortened getworklink URL. The WorkLink App will launch when the shortened getworklink URL is opened with a browser.
This getworklink URL is going to be used with Docebo’s xAPI external content system, which will redirect the user to the URL specified in the training course (more on that later).
On Advanced Settings, click on E-Learning:
On the right side, there will be a form to add URLS to xAPI (Tin Can) external content:
Use that form to add the getworklink service to the list of whitelisted urls (make sure to add an asterisk * at the end):
Clicking on the add button will add the getworklink service to the whitelist.
Your getworklink service might be different if you are using an on-prem version of ScopeAR. You can check the getworklink service URL by going to the CMS and looking at a scenario’s getworklink URL.
Step Three: Create Public Key and Secret
In order for the integration to be secure, a public and private key needs to be generated. There are various means to create one. For the sake of this tutorial, we will use the https://cryptotools.net/rsagen
Click on the link to be brought to the RSA Key Generator and then click on the Generate key pair to have a public and private key generated:
Copy the Private key and save it to a text file called private_key.pem:
Copy the public key to a text file and save it as public_key.pem :
Great. We now have a public and private key pair to use for our API Credentials.
Step Four: Add API Credentials
In order for the webhook subscription requests to be sent to Docebo, the requests need to be authenticated. This will require setting up the API Credentials in Docebo.
Go to the Admin Settings in Docebo:
Click on the Manage link under API AND SSO:
Next, click on the API Credentials link on the left nav menu:
Add a new set of credentials by clicking on the Add OAuth2 App button:
In order to make the correct credentials for the API integration, click on Show Advanced Settings:
Then click on JWT Bearer so that a JWT Bearer Token can be used to authenticate:
Add the URL for the Worklink CMS to the Redirect URI:
Create a unique client ID for the API Credentials. This can be any string you want it to be. Just make note of this string as you will need it again later.
Upload the public key (public_key.pem file) that was created in the earlier step:
Copy the client secret that has been generated (to be used in the next step):
Save the API Credentials by hitting the Confirm button:
This will bring you to the API Credentials list.
From here, enable the API Credentials by clicking on the checkmark icon:
Step Five: Create New Integration
This is where the magic happens. We will create the integration between Docebo and ScopeAR. We do this by creating an Integration object which is more or less a collection of Webhooks that will send data from ScopeAR to Docebo.
Log into the Worklink CMS and click on the Integrations link under Developer Tools:
You will now be on the Integration list page. Click on the Connect Integration button to create a new integration:
Clicking on the button will bring up the Connect Integration form. Select Docebo from the drop-down list:
Next, add your custom Docebo URL to the API URL text field:
Click the Save button at this point. Though we are not done yet. The API credentials (used to authenticate Webhook requests to Docebo) need to be added.
Click on the Docebo Integration link on the list of integrations:
You are now on the Integration details page. Click on the Edit Integration button to bring up the edit form:
Enter into the Client ID field the client id that was created for the API Credentials:
Paste the client secret (generated from the last step) in the Client Secret field:
Lastly, copy and paste the private key (from the private_key.pem file) into the JWT Private Key field:
Save the edited Integration by clicking on the save button:
Congratulations! You have just setup your integration between Docebo and ScopeAR!
Step Six: Create A Course
Now, let’s create a new course in Docebo that uses the integration that you just made. Begin by logging into your Docebo dashboard as an admin, and go to the Admin Menu by clicking on the gear icon on top right corner:
From there, go to Course Management:
Then Click on the Green box on the right side to bring up a menu:
On this menu, click on New Course:
Fill in the required fields and then create the course:
At this point, we have created a new Course. Now let’s add some training materials.
Step Seven: Add Training Material
Once you’ve created a Course, you can add training materials to this. Click on the Training Material tab on the course management page:
Click on the Add Training Material button:
Select the xAPI (Tin Can) link:
Click on the From URL checkbox to expose the Select URL dropdown:
In the Select URL dropdown, select the getworklink URL that was created earlier:
Before we can continue, we need to locate the scenario in the Worklink CMS. Log into the Worklink CMS, navigate to the Content page, and select a scenario from the list:
On the scenario details page, locate the link:
Copy the last alphanumeric characters on the link (in this case, it’s 4mCo):
Go back to the Docebo training material form and add paste the characters into the Additional path field:
Next, you will have copy the name of the scenario and add it to the Title field of the training material (in this example its QA_Everything):
Paste the name into the title field:
Next, just save the training material. It should pop-up on the training material course list:
Step Eight: Change the Training Material Settings
Select the menu button to the right side of the training material and select the Settings option. This will open a settings dialog for the training material.
Change the Launch Mode to “Play in New Window” and save your changes
Congratulations! You just created a training course that integrates with ScopeAR’s Worklink!
Step Nine: Test
Now it’s time to test. This is rather straightforward: just launch the training course and complete the training in the Worklink App.
When you click Start Learning, this will launch a webpage from which you can either launch the Worklink app or you can scan the QR code on the page to launch the quiz material in the Worklink app on another device. Either way, once the scenario has been run and any quiz material completed with a passing grade, then the quiz in Docebo will be automatically marked as complete.
To find the score of the training session, go to User Stats
Scroll all the way to the bottom and you’ll see this. Score is the farthest right value