Activating Canvas

Activate the Integration
To use the Canvas integration, the Planning & Self-Study System Administrator must activate the integration to establish the connection with your institution's instance of Canvas. To do so, please follow these steps: 

In Planning & Self-Study, go to Admin > Integrations > Other Integrations. Click “Connect to Canvas”.
Connect to Canvas option.

Follow the steps as indicated to establish the connection. If you do not have administrative access to Developer Keys in Canvas, please reach out to someone who does for assistance.
Steps to connect Planning & Self-Study to Canvas.
Open a new tab and login to Canvas. 

By default, the scoping is disabled when creating a developer key. For the institutions that had already set up their integrations, the scope option will be disabled. However, the scopes can be updated for a developer API key at any time.


Key things to consider when enabling scopes

a. All the required endpoints must be selected in the key in order to make the integration work seamlessly. The integration will not work even if one of these endpoints is missed.

b. Allow Include Parameters option must be selected in an API key. "Includes" parameters may grant access to additional data that is not included in the Endpoints table.

c. Ensure that no additional endpoints are selected other than the required ones in an API key.


Creating API Developer key and Enabling Scopes

Open a new tab and login into Canvas.


In Account Navigation, click the Developer Keys link. 


Go to the Admin page and click on Developer Keys. 
Click Add Developer Key. Select the Add API Key option. 

Insert the URL that is listed in P&SS. 

By default the scopes are disabled. Click the Enforce Scopes button to enable.

Click the Allow Include Parameters checkbox to permit usage of all "includes" parameters for this key.

There are API endpoints that must be selected in an API key. The following endpoints will fetch the Courses, Assignments, Rubrics, and results data from Canvas.


You can search the endpoints that are required to fetch the necessary assessment data. To search for a specific endpoint, type the name of the endpoint in the Search Endpoints field. To see all available endpoints, scroll through the Endpoints table.



Required API endpoints

a. url:GET|/api/v1/courses

b. url:GET|/api/v1/courses/:course_id/assignments

c. url:GET|/api/v1/courses/:course_id/rubrics/:id

d. url:GET|/api/v1/courses/:course_id/assignments/:assignment_id/submissions

e. url:GET|/api/v1/accounts

f . url:GET|/api/v1/accounts/:account_id/courses


Save the API Key. 
This does not require any changes in the Planning & Self Study application. Once the scopes are enabled, we can utilize the key to make the connection to Canvas in P&SS.


In Planning and Self-Study:

Set up integration on integration page using an overall admin account.


Creating Admin Role to import rubric data

Minimum set of permissions required by account role in Canvas

In order to be able to fetch assessment results from Canvas as an account admin, there are a set of permissions that an account role must have in Canvas. These permissions will allow the P&SS to leverage the account role to seamlessly fetch all the required data. 


Please refer to the following steps to create an account admin role with the permissions listed below.

  1. Log in as an administrator in Canvas.
  2. Go to the Admin side menu.
  3. Add user as an P&SS admin at the root account level. 
  4. Click Permissions side menu.
  5. Click on Account Role tab.
  6. Click on the role name.
  7. Click edit icon.
  8. Select the following permissions.
  • Course Content - view
  • Courses - view list
  • Grades - view all grades
  • Reports - manage
  • Rubrics - add / edit / delete


Add user as admin role created above

Create a user account role and add it as an account admin in Canvas. Refer to the following steps on how to add a user as an account admin in Canvas.

  1. Log in as an administrator in Canvas.
  2. Click Admin in the user navigation menu.
  3. Select the root Canvas account, for example: EvaluationKIT as shown in the snapshot.
  4. Go to Settings in the account navigation menu.
  5. Click the Admin tab.
  6. Click + Account Admin button.
  7. Select the role as P&SS Admin in Add More drop down. 
  8. Insert the email address of the user.
  9. Click Continue.
  10. Click OK Looks Good, Add This 1 User.

The user will be added as the P&SS account admin.


What can be integrated? 

Once the integration has been set up, users in P&SS are able to align results in a measure.

  • Users can select a course. These courses are the ones that the user has access to in their Canvas account (the credentials used for authorization). Only one course can be selected.
  • All the courses from the user’s instance in canvas will be available in P&SS through the integration.
  • Unpublished courses are also available in P&SS.
  • Outcomes created in the courses (in canvas account) cannot be accessed through integration.
  • Under the case, the assessment lead (the canvas authorized user) is not added as a teacher in the course then that course cannot be accessed through integration.

Users in P&SS can align results from Assignment type of assessment activity.

  • Assessment activities are Assignment. Users can pull relevant assessment results as evidence. (Quizzes are not accessed through the integration).
  • Unpublished assignments are also available in P&SS.
  • User needs to add a rubric to the assignment in canvas account for it to populate in the assignment dropdown to choose an assignment.


Assessment results are fetched through integration from Canvas based on the selections made in the rubric criterion.



Was this article helpful?
0 out of 0 found this helpful

Articles in this section

How to Contact Support
There are many ways to reach out! Click here for our support options.
Watermark Academy
Click to access the Watermark Academy for consultation, training, and implementation companion courses.