1. Home
  2. Help
  3. Learning Management Systems
  4. Canvas
  5. Creating Canvas Developer Credentials for the Hypothesis LMS App
  1. Home
  2. Help
  3. Learning Management Systems
  4. Installing in the LMS
  5. Creating Canvas Developer Credentials for the Hypothesis LMS App

To enable advanced Hypothesis integration with Canvas, a Canvas administrator will need to generate a Canvas Developer Key before Hypothesis is installed.

This key will be tied to the Hypothesis credentials you create as part of the install process, and enables the following deeper integrations with Canvas:

  • Access to Canvas Files for documents
  • Integration with Canvas Groups
  • Integration with Canvas Sections

For more detail, please see our article on the Canvas API endpoints used by the Hypothesis LMS app.

Note that deleting the Canvas Developer Key and/or creating a new Developer Key for Hypothesis will require creating a corresponding new set of Hypothesis credentials and installing a new instance of Hypothesis in Canvas.

1. Create a new Canvas Developer Key for Hypothesis

Navigate to Admin > Developer Keys and click on the +Developer Key button. Choose the +API Key option after clicking “+Developer Key”.

Add Canvas Developer Key page

2. Fill out the Key Settings form

  • Key Name:
    • Hypothesis
  • Owner Email:
    • Enter an appropriate email address
  • Redirect URIs (make sure there are no extra spaces or characters copied and pasted here):
    • https://lms.hypothes.is/canvas_oauth_callback
      https://lms.hypothes.is/module_item_launch_oauth_callback
  • Redirect URI (Legacy):
    • leave blank
  • Vendor Code (LTI 2):
    • leave blank
  • Icon URL:
    • https://d242fdlp0qlcia.cloudfront.net/uploads/brand/HypothesisCanvasIcon.png

3. Click Save Key.

Save Canvas Developer Key

4. Turn the Key on.

Canvas does not turn on Developer credentials by default. Turn on your Developer Key before leaving this page.

Location of "On" button

The ID (shown in the Details column) and Key (shown in a pop-up once you click the Show Key button) will correspond to the Canvas Developer ID and Canvas Developer Key fields in our form to generate Hypothesis credentials:

Locations of Developer ID and Key

5. This step should only be used if your institution enforces scopes on Developer Keys

The following are the API endpoints that Hypothesis requires (organized by category):

  • Files
    • url:GET|/api/v1/courses/:course_id/files
    • url:GET|/api/v1/files/:id/public_url
  • Courses
    • url:GET|/api/v1/courses/:id
    • url:GET|/api/v1/courses/:course_id/users/:id
  • Sections
    • url:GET|/api/v1/courses/:course_id/sections
  • Group Categories
    • url:GET|/api/v1/courses/:course_id/group_categories
    • url:GET|/api/v1/group_categories/:group_category_id/groups
  • Groups
    • url:GET|/api/v1/courses/:course_id/groups

Additionally, you must enable the use of Include ParametersLocation of Allow Include Parameters checkbox

Related Articles

In order to support easy reuse, revision, remixing, and redistribution, the entire Hypothesis Help knowledge base by Hypothesis is dedicated to the public domain via CC CC0 1.0. While we appreciate attribution and links back to Hypothesis from anywhere these works are published, they are not required. Learn more about how we made the decision to put our guidance in the public domain and let us know how you are putting Hypothesis Help to good use.