Litmos Eligibility & Results Integration
Overview
The Certiverse–Litmos integration lets a Litmos course control who can book a Certiverse exam, and writes the exam outcome back to that course. Certiverse checks the candidate's Litmos course assignment in real time at booking, then marks the exam module in Litmos with the score and pass/fail as soon as the exam is completed.
The integration consists of three components:
| Component | Direction | How it works |
| Deep link from Litmos | Litmos → Certiverse | An exam module in the Litmos course opens the matching Certiverse store exam, optionally through SSO. |
| Litmos Live Eligibility | Certiverse → Litmos | At booking, Certiverse finds the candidate in Litmos by email and confirms they have an active, incomplete assignment for the configured course and module. |
| Litmos results write-back | Certiverse → Litmos | When the exam is completed, Certiverse updates the configured module with the percent score and marks it complete on a pass. |
Because Certiverse completes the module through the Litmos API, the exam module in Litmos must not auto-complete when the candidate launches it (see Litmos Configuration).
Certiverse Configuration
Your Organization Admin sets this up in two steps: create a Litmos connector, then assign it to each store exam with a course and module. Results write-back uses the same configuration, so there is no separate results setup.
Step 1: Create the Litmos eligibility connector
Available to Super Admin, Certiverse Admin, and Organization Admin roles.
- In the Admin Portal, go to Connectors.
- Select the Litmos Live Eligibility tile and click Connect.
- Click Add Connector
- Enter a Connector Name. It must be unique within your organization across all providers.
- Enter the API key from your Litmos account.
- Click Validate
- Click Save. The connector is created only if the API key is valid.
Once saved, the API key is stored encrypted and can be replaced but never viewed in full. A connector that is assigned to a store exam cannot be deleted.
Step 2: Assign the connector, course, and module to a store exam
- Navigate to the Store tab
- Click EDIT on the desired exam
- Open the Eligibility Configuration tab within the exam
- Select the configured Organization Connector
- Under eligibility, set Eligibility Type to Litmos.
- Enter part of the course name in Course Search and click Search (or press Enter).
- Select the Course from the results, which are listed alphabetically.
- Select the Module that represents the exam. Only modules in the selected course are listed.
- Click Save.
Changing the connector or running a new course search clears the course and module, so both must be selected again. If a course has no modules, it cannot be saved; add the exam module in Litmos first.
Once saved, the eligibility tab shows the Litmos course and module IDs with their names. If either has been removed in Litmos, the tab shows "Course Id not found" or "Module Id not found" instead.
Step 3: Results write-back (automatic)
No extra setup is needed. Every store exam with Litmos eligibility writes results back to the configured module. Other result types in Exam Management > Summary > Results Configuration (for example, a Certiverse Results push) can still be added alongside it.
Candidate Flow & Eligibility Verification
Candidates start in the Litmos course and are checked for eligibility the moment they select the exam in Certiverse.
- The candidate opens the assigned course in Litmos and launches the exam module.
- The module opens the Certiverse store exam deep link in a new tab. If your organization uses SSO, the candidate is signed in on the way.
- Certiverse looks up the Litmos user by the email on the candidate's Certiverse account.
- Certiverse reads that user's assignment results for the configured course.
- The candidate is eligible only if the course assignment is active and not complete, and both the course and the configured module have a result record (the module has been launched).
- If eligible, booking continues and Certiverse stores the Litmos module result ID as the booking's eligibility ID. If not, the candidate sees a Not Eligible message and cannot book.
- The candidate schedules (or, for unscheduled exams, starts) the exam under the store exam's own date and retake rules.
The match is by email, so the candidate's Certiverse email must match their Litmos user exactly. Using the same SSO identity provider for Litmos and Certiverse is the most reliable way to keep them aligned.
Eligibility Flow
Litmos owns the course assignment; Certiverse reads it at booking and closes it only by completing the module on a pass.
| Stage | What happens | Owner |
| Open | The user is assigned the course in Litmos and the assignment is active. | Litmos |
| Ready | The candidate launches the exam module, which creates the module result record Certiverse checks for. | Candidate in Litmos |
| Checked | At booking, Certiverse confirms the assignment is active and incomplete and records the module result ID. | Certiverse |
| Passed | Certiverse marks the module complete. Once the course is complete, the candidate is no longer eligible. | Certiverse → Litmos |
| Failed | Certiverse records the score but leaves the module incomplete, so the candidate can book a retake under the store exam's retake rules. | Certiverse → Litmos |
Results Flow
Certiverse updates the configured Litmos module through the Litmos API when the exam is completed. Results are sent per exam, not in a batch.
| Field sent to Litmos | Value |
| Course ID / User ID | The configured course and the Litmos user found at booking |
| Score | Percent score |
| Completed | 1 on a pass, or when the exam has no pass/fail set; 0 on a fail |
| Updated at | Date and time of the result |
| Note | Pass or Fail |
Downstream actions. Anything your Litmos course does on completion (certificates, learning paths, badges) runs when Certiverse marks the module complete. If you issue badges from Certiverse instead, turn off the matching badge in Litmos to avoid duplicates.
Litmos Configuration
Your Litmos administrator completes these items; Certiverse needs the API key and the course and module names from them.
API key
A Litmos account administrator generates the API key used in the Certiverse connector. See the Litmos developer API overview. Replace the key in the connector whenever it is rotated in Litmos.
Course and exam module
- Create (or choose) the course that controls eligibility and assign it to the candidates who may test.
- Add one module to that course to represent the Certiverse exam. Use a module name that is easy to find when configuring the store exam.
- Build the module as a SCORM package that opens the Certiverse deep link in a new tab and does not report completion. Certiverse completes it through the API; a module that auto-completes on launch closes the course before the candidate books.
- Make sure Litmos users' emails match the emails candidates use in Certiverse.
SSO and deep links
Your Certiverse contact provides the store exam deep link (also available from Copy Store Exam URL on the store exam). If your organization uses SSO, use the SSO deep link with an exam redirect so candidates are signed in and taken straight to the exam. Open it in a new tab rather than inside the Litmos player, since many identity providers block sign-in inside frames.
Troubleshooting
Most issues come from an email mismatch between Litmos and Certiverse, or a module that has not been launched or has already completed.
| What the candidate sees or reports | Likely cause | How to resolve |
| Not Eligible when selecting the exam | No Litmos user has the candidate's Certiverse email | Confirm the email matches exactly in both systems, or have the candidate sign in through SSO. |
| Not Eligible, but the user is in Litmos | The course is not assigned, the assignment is inactive, or the course is already complete | Check the user's course assignment in Litmos and reassign or reactivate it. |
| Not Eligible, assignment looks correct | The candidate has not launched the exam module yet, so it has no result record | Have the candidate launch the exam module from the course in Litmos, then try again. |
| Not Eligible after passing | Expected: the module and course are complete | If a retest is needed, reset or reassign the course in Litmos. |
| Course closed before the candidate booked | The exam module auto-completes on launch | Rebuild the module so it does not report completion, then reset the user's course. |
| Score missing in Litmos | The module was removed or changed after booking, or the Litmos user changed | Confirm the module still exists in the course. Ask Certiverse support to check the result write-back. |
Connector and configuration errors (admins). If the connector will not save, the API key is invalid or expired; generate a new one in Litmos. If the eligibility tab shows "Course Id not found" or "Module Id not found", the course or module was deleted or moved in Litmos; select them again and save. If a connector cannot be deleted, remove it from every store exam first.
Contact Us
If you have any questions or need additional assistance, please contact us by emailing support@certiverse.com or by submitting a ticket.
Updated
Comments
0 comments
Please sign in to leave a comment.