Caveon Integration Set-Up

  • Updated

Integrate your Skilljar training site with Caveon to provide secure and versatile assessments to your students. You can embed Caveon exams into Skilljar lessons to provide a seamless exam experience in Skilljar while utilizing Caveon’s wide variety of assessment types and its market-leading exam security features.

Set up the integration

To set up the Caveon integration, you will work with your Implementation Manager or your Customer Success Manager. They’ll partner with you to set up, test, and go live with the integration.

Access API Credentials in Scorpion

  1. Please ask your Caveon Account Manager to create a Skilljar integration App in Scorpion. Additionally, ask them to configure the App settings for the non-proctored Caveon exam type in Skilljar.
  2. Once that has been created, you will be able to select the Scorpion Skilljar App from the Scorpion menu:


  3. Select your Skilljar App from the list and select Get API Credentials. Leave this screen open so that you can copy the different pieces of information into Skilljar in the next step.

Please note: this action will invalidate previously created Scorpion credentials you might already use, such as in a Skilljar Sandbox. If you already have credentials for this app, you should use those existing credentials.


Add Integration Credentials to Skilljar

  1. Once you have the API credentials generated, please open in a new tab

  2. Select Add Integration and enter your Scorpion Skilljar App credentials:


3. When entering the API credentials:

  • Name: You can choose a name that helps you identify the integration. For example, “MyCompany Caveon”.

  • API Token: “Authorization” in Caveon, this is pulled directly from the Caveon API credentials page

  • Embed Exam:

    • If selected, Skilljar will embed the Caveon exam in all Caveon lessons. Students will not need to leave the Skilljar platform to take the exam and have a more seamless experience. There are a few limitations when embedding Caveon exams in Skilljar lessons. Please review the section below to understand the capabilities and limitations of embedding Caveon exams.

    • If you don’t select “Embed Exam”, Skilljar opens the Caveon exam in the same tab and the student leaves the Skilljar platform to take the exam.

  • Secret Key: “Secret” in Caveon, this is pulled directly from the Caveon API credentials page

  • Webhook URL: You don’t need to enter any information in this field. Once you save the new integration, Skilljar will display the correct webhook URL for the next setup step in Caveon.

Note: These Caveon settings are Skilljar Organization-wide, so they will apply to all Caveon exam lessons you create in the Dashboard.

Add a Webhook to send Exam Results from Caveon to Skilljar

The webhook listens for the exam results in Caveon, so that the results and completion status are added to the Student profile in Skilljar. You can use the integration without setting the webhook up. Please note that without the webhook, Skilljar will not receive any results from Caveon and will not complete the Caveon lessons automatically.

  1. Now that you have added the Caveon integration, open your integration again. There is a field called “Webhook URL”. Copy the URL in this field. You will need only this webhook address to support the entire Caveon integration.

  2. Once you have the webhook address, go to Scorpion, open your Scorpion Skilljar App and select ‘Hooks’ in the app menu.


3. Select “Delivery: Completed” from the dropdown

4. Select Add Hook

5. Paste the webhook address into the new field and save the hook.


Update and Review Scorpion App Permissions

To make sure the integration works smoothly, please check that the Scorpion Skilljar App has the correct permissions set.

  1. Go to Scorpion, open your Scorpion Skilljar App

  2. Select Permissions in the app menu. The integration between Skilljar and Scorpion requires all permissions in the Delivery section to be checked. If they are not checked, please select all permissions under Delivery and select Save.


Every Scorpion project represents an exam. In order for Skilljar to access and display the exam, you have to add the Scorpion project to the Scorpion Skilljar App. Skilljar only has access to projects that are connected to this App.

  1. Select your project and expand the drop-down menu in the top bar.

  2. Under Project, select Access.


  3. Select the Integrated Apps tab.

  4. In the Available Apps search bar, select the Scorpion Skilljar App and then select Integrate. This will allow Skilljar to access the project.

This process will have to be repeated for all projects you want to use as exams in Skilljar.

Note: Skilljar only accepts integer-based scores. Using decimal scores will create an error. To set Score display type to Integer, follow these steps:

  1. Open the form you wish to integrate with Skilljar and select Edit Config.


  2. Scroll down and set Score display type to Integer.


Define custom fields so that Skilljar can exchange all necessary data with Caveon

Skilljar creates a user and exam instance for each instance of a Skilljar student taking a Caveon exam. This allows for a seamless student experience without the need to create a profile or log in to a Caveon account before they can start the exam.

In order for Caveon to properly process the student information, you need to add examinee info fields either on an organization level or for each project. These examinee info fields are also required to ensure that results, success status, and completion are correctly sent back to Skilljar. Please note that this integration requires these fields. There is no option to have students create profiles manually.

  1. Select Projects from the menu and select one of the exams (projects) you want to use in Skilljar.

  2. Open the settings for this project and select the Delivery Settings tab.

  3. Add the following Examinee Info Fields: First Name, Last Name, Email, SLP_ID (student lesson progress ID, which identifies a specific student’s progress in a lesson), as displayed in the screenshot below.


Add the same fields to each exam you want to use in Skilljar. You can also set these on a Caveon organizational level so that you don’t have to add them to each exam/project. Please reach out to your Caveon Account Manager if you want to add these fields on an organizational level.

Create a Caveon lesson in Skilljar

This section walks through how to create a Caveon lesson in Skilljar and connect your Caveon exam to your Skilljar course.
  1. Go to your Skilljar dashboard

  2. Select the Course Management header and then select Courses to open the Course Management page
  3. Select the course you would like to edit or create a new course

  4. The lesson dropdown now contains the option ‘Caveon Exam’

  5. Complete the below fields for a new Caveon Exam:

    • Display Name: A subtitle within the lesson content. You can leave this blank if you only want to use the Lesson title

    • Integration: Select the Caveon integration you just set up, for example, “MyCompany Caveon”

    • Caveon Exam Id: You can copy the Caveon Exam ID in Scorpion. Go to the project you want to use as the exam and copy the id behind the projects/ part in the URL:


  • Allow Students To Return To Their Exam Attempt: A lot can happen during an online exam - a student accidentally clicks on another lesson, their laptop shuts down, or the browser suddenly installs an update. This setting defines the student experience in such an instance.

    • If this setting is turned on, students will be able to return to their exam attempt and complete an exam they already started. When they click on the unfinished Caveon exam lesson, they will see the ‘Begin Exam’ button. Clicking on the button starts the Caveon system requirements check and then opens their existing exam with all previous answers.

    • If you don’t allow students to return to their exam attempt, they will only be able to start a Caveon exam once. When a student returns to an unfinished exam lesson, Skilljar will inform them that they can only access the exam once and won’t allow them to proceed to the exam.

      Please note that this improvement will not have any effect on Caveon exams that are proctored with Examity.

  • Content: The content is displayed in the lesson above the button to launch the exam. Use this section to inform students about the exam, procedure, help links, etc. You can also add custom code snippets, e.g. to customize the lesson or to hide the button to launch the exam.

  • Button Name: By default, the button to start the exam is called “Begin Exam”. You are able to edit this copy.

  • Open the ‘Settings’ section. At the very top is a setting called ‘Requires validation’.

    • If ‘requires validation' is turned on, then Skilljar will not complete the lesson automatically when it receives the results from Caveon. This way, an admin can review the proctoring results in the proctoring tool and manually complete the course. Learn more about manually completing a course here.

    • If ‘requires validation’ is turned off, then Skilljar will automatically complete the lesson after receiving the Caveon results. Depending on your settings, Skilljar may also complete the course, if the exam was the last required lesson to complete and if the course has the “Use lesson score as course score” enabled. If you want courses to complete automatically, please make sure to “Use lesson score as course score” and to select the Caveon lesson. This could trigger a certificate or badge to be created, learn more about issuing certificates here. We recommend using this setting when using Caveon as a stand-alone exam without proctoring.

Student Experience:

Embedding Caveon Exam

This is an example of an embedded Caveon exam:


The Caveon exam is displayed as the Skilljar lesson content. Students can navigate through the exam within the lesson. If you choose not to embed the Caveon exam, Skilljar will display the same content in a full tab:


Limitations of embedding Caveon in the Skilljar Lesson:

  • Browsers
    Safari and iOS don’t support embedding the exam. If you want to allow users to take exams on iOS devices and with the Safari browser, we recommend that you do not embed the Caveon lesson. If you decide to embed Caveon, we recommend that you inform users about supported browsers before they start the exam. You can use the ‘Content’ field on the Caveon lesson for this purpose.

  • Student Interaction
    Caveon monitors student activity while taking exams and generates a warning when students click on something or hover outside of the exam page. This warning is also generated when students click on something or hover outside of the embedded area but inside the Skilljar platform. Please note that these warnings do not reflect cheating. To avoid these warnings, we recommend informing students about this before they take the exam. You can use the ‘Content’ field on the Caveon lesson for this purpose.


If you’re getting an error in the live Caveon lesson (for example, “There was a problem. Please try again later.”) and you’re not seeing any console errors, this could point to a misconfiguration on the Caveon side. Reach out to the Caveon team to confirm that the App settings are configured for the non-proctored Caveon exam type in Skilljar.


What information is sent back to Skilljar?

Caveon sends pass/fail information, a student’s score, and the maximum achievable score. We save this information on the Caveon lesson. Customers can see the score under ‘Students’ by selecting the student and then selecting the exam course.

To set the score and max_score values, Skilljar uses Caveon's value of 'points_earned' as 'score', and 'points_available' as 'max_score'.

In the ‘Settings’ section of Caveon lessons, is a setting called ‘Requires Validation.’


  • If ‘requires validation' is turned on, then Skilljar won’t complete the lesson automatically when it receives the results from Caveon. This makes sense when a customer also uses proctoring for a Caveon lesson. An admin can review the proctoring results in the proctoring tool and manually complete the course based on the proctoring results.

  • If ‘requires validation’ is turned off, then Skilljar will automatically complete the lesson (and potentially course if the exam was the last required lesson to complete and the course has the right settings - “Use lesson score as course score”). This is the recommended setting when using Caveon without proctoring.

Are students required to create an account or profile in Caveon?

No, Skilljar creates a student profile in Caveon when the student clicks on the Caveon lesson. Skilljar opens the exam and authenticates the student automatically so that the student never has to enter any personal information or log in before they can start the exam.


Was this article helpful?

1 out of 1 found this helpful