Skip to content

Canvas Integration Guide

Before Getting Started - Please share iCEV's system requirements with your technology department.


Things to consider before using the integration

  • Multiple internet filters and firewalls.
  • Different settings for wired and wireless technology devices.
  • Software on technology devices that act as an internet filter or firewall.
  • Students are automatically registered through the integration.
    • Please do not register students through iCEV
    • Students will roster back to the iCEV account and iCEV course the common cartridge gets created.
  • Grades will be visible in both iCEV and the integration's gradebook.
    • The “Highest” scored grade will be passed back to the integration gradebook.

NOTE: Student licenses and teacher accounts must be purchased to use the integration.

Administrators' Guide

NOTE: This process should be completed by the Canvas Administrator.

  1. Login to Canvas with an Administrator account
  2. Click Settings
  3. Click Apps
  4. Click View App Configurations
  5. Click +App
  6. The Add/Edit App window will appear
    • Configuration Type: Manual Entry
    • NameiCEV
    • Consumer Key: {Please contact us for this information}
    • Shared Secret: {please contact us for this information}
    • Launch URL:
    • Domain:
    • Privacy: Name Only
    • Custom Fields:
      • courseId=$
      • assignmentId=$
      • duedate=$Canvas.assignment.dueAt
      • lockAt=$Canvas.assignment.lockAt.iso8601


Adding an Administrative Access Token

NOTE: This process must be completed by your Canvas Administrator; this process is optional. The administrative access token will allow teachers to control the number of attempts a student is given; for each assignment by Canvas.

  1. Login to Canvas with an Administrator account
  2. Click Account
  3. Click Settings
  4. Click +New Access Token
  5. Purpose: iCEV API Application
  6. Expires: {Leave Blank}
  7. Click the Generate Token button
  8. Send an email to Customer Support with:
    1. The token key
    2. The Canvas domain name
      • Example: https://{domain_name}

Teachers' Guide

NOTE: These steps assume that the Canvas Administrator has setup the external tool (integration) in Canvas. If they have not, please send the Administrators Section to the Canvas Administrator.

Step 1 - Export Lesson from iCEV

NOTE: It's recommended to only export one lesson at a time.


  1. Go into the iCEV Lesson
  2. Make certain that the lessons that need to be exported are set to be Visible to Students
  3. Make certain that the assets (assignments, assessments, and resources) that need to be exported are set to be Visible to Students
  4. Click Export Common Cartridge
  5. Click Export
  6. The file (common cartridge) will download

Step 2 - Import into Canvas


  1. Go to the Canvas Sandbox Course
    • The term Sandbox may be different in your organization:
      • It is an empty course that is unpublished
      • It has no students enrolled in it
    • Do not import directly into a Published Course; data loss can occur
      • Data recovery typically is not possible; this must be done by the Canvas Administrator
  2. Click Home
  3. Click Import Existing Content
  4. Content Type: Select – Common Cartridge 1.x Package
  5. Click Choose File
    • Select the recently downloaded common cartridge file
  6. Content: Click – All content
    • Unless you know that you need something specific
  7. Click Import
  8. Wait for Canvas to complete processing the file
  9. Click Modules


Step 3 - Copy the Lesson into Course


  1. Click the three dots to the right of the Module Header
  2. Click Copy To…
  3. Select the Course
  4. Click Copy
  5. Click Close
  6. Click Courses
  7. Go to the Course


Lesson Visibility



Assignment Visibility Settings



Student Feedback Options



Attempt Threshold Options



Canvas Course Assessments




Canvas is acting strangely what can I do?

Please review this resource to see how Canvas / Instructure is running worldwide: Canvas Status

Please review this resource to see how your specific host is running: Canvas Region Status

What does "Error Couldn't retrieve LMS Data." mean?

This error message appears if the internet or network is running slowly or is unstable.

Step 1
If the student refreshes the browser a few times the error message should go away.

Step 2
If the error message is very persistent; please have the student clear their internet history and cache.

If using an Apple device
Please use this resource to disable “Prevent cross-site tracking” in the Safari browser.

Step 3
If after refreshing and clearing the internet history; the message still appears please verify that third-party cookies are not being blocked.
All student grades are zero (0), what can be done?
  1. Go to the Course
  2. Go to Module
  3. Look at the assignment that is reflecting all zeros (0)
  4. Double-check the point value for the Canvas external tool assignment and that the value is something other than zero (0). If it is set to zero (0), set the point value to something different and have the students re-submit the assignment. Have the students follow the directions in “Some student grades are missing what can be done?”

Some or all student grades are missing, what can be done?
  1. Have the student go back to the assignment that is missing the grade.

  2. Have the student click the text that says Summary.
Grades are not showing under the correct assignment in the Canvas Gradebook

Most likely this scenario has happened:

  • The student opens Assignment “A” and tries a few questions.
  • The student then opens Assignment “B” in a new tab or window on the same browser.
  • The student moves back to Assignment “A” and sends the assignment.

In this scenario, scores will appear under Assignment “B” rather than Assignment “A” because scores are sent back for the last opened assignment (Assignment “B” in this case) on the browser as the session is updated.

What does "Couldn't find valid settings for this link." mean?

The External Tool needs to be updated. Add to the Domain field.

How can I see when grades were received by the Canvas Gradebook?
  • Go into the Course
  • Click Grades
  • Wait for the gradebook to appear
  • Click Gradebook
  • Click Gradebook History
  • Gradebook History shows as grades are coming in. Under Grader, anywhere Not Available is visible.
    That is Canvas receiving the grade from iCEV or any other external tools being used.
  • For further information, please review this resource: 
    Canvas - How do I view the history of all grading changes in the Gradebook?

We're Here to Help

If you have any questions or need additional support, please contact us using one of the options below:

Email Us