TABLE OF CONTENTS

• Overview
• Canvas API
• OAuth2 Configuration
  • Canvas
  • Qualtrics LTI

Overview

When creating a new data field, the following options allow for ‘Custom endpoints’:

• Student launch → API value
• Student launch → API selection
• Assignment setup → API value
• Assignment setup → API selection

These allow you to specify a custom Canvas API endpoint (and attribute), which will be contacted when the data field’s value is retrieved at the chosen location.

Most of the time, you will not need to use these custom endpoints. If you do, then you first need to reach out to us at support@drieam.com, as some OAuth2 configuration is required on our end and in your Canvas Developer Key settings.

Canvas API

Please refer to the Canvas API documentation to see which endpoints and attributes are available to you.

Note: You can use :course_id and :user_id in the endpoint path. These will be replaced by the actual values when retrieving the data. For example, to get all users in a course you would use /api/v1/courses/:course_id/users.

OAuth2 Configuration

Canvas

In order to use the API endpoint you have chosen, you need to make sure that the associated scope is enabled in the API Developer Key that you set up when installing Qualtrics LTI on your Canvas instance.

The associated scope is specified in the Canvas API documentation for the endpoint.

Note: If you do not have an API Developer key (and instead use our ‘Qualtrics by Drieam’ Inherited Key), then you cannot change your scopes yourself. As such, you cannot use custom endpoints.

Qualtrics LTI

We request a default set of scopes for all Canvas instances. In order for your custom endpoint to work, we will need to make sure that your version of the app always requests that scope.

This is done on a case-by-case basis, so please reach out to support@drieam.com to facilitate this.

Warning: If you do not enable the scope first, then Qualtrics LTI will stop working for all users until the correct scopes are enabled.