Canvas LTI 1.3 Setup Guide [FOR ADMINISTRATORS]

IN THIS ARTICLE
LTI 1.3 Setup Steps
    STEP 1
    STEP 2
    STEP 3
Root Level App Placement (most common)
Sub-Account Level App Placement
Course Level App Placement

This guide is primarily for Canvas Administrators or whoever manages your institution's Canvas environment. If you don’t see the Admin options on your Canvas site navigation (refer to the image below), you'll want to reach out to your institution to request integration assistance (must have the “Developer Keys – manage” permission).

A brief overview of the setup guide:

1. Complete steps 1 & 2 below inside your Canvas environment.
2. Send your client ID and entire Canvas domain in the Yellowdig integration form. (Request the Yellowdig integration form through support)
3. Wait for Yellowdig to confirm via email that your setup is completed.

After completing the steps above and getting the confirmation in step 3, you can then place the Yellowdig app at the root level or the course level.

LTI 1.3 Setup Steps

STEP 1

In Canvas, navigate to Admin Developer Keys and click + Developer Key. Select the LTI Key option.

STEP 2

Create a new LTI Key with the following:

• Select "Enter URL" under the Method dropdown,
• Enter the JSON URL: https://yellowdig-dev.s3.amazonaws.com/lti3-json/yellowdig-default-canvas-config.json 
  • AUSTRALIA REGION? Use this JSON URL instead https://yellowdig-dev.s3.amazonaws.com/lti3-json/yellowdig-au-canvas-config.json
• Enter a Key Name of your choice (EX: "Yellowdig 1.3")
• Enter your Email address.
• Enter the Redirect URIs: https://api.yellowdig.app/lti3/unpack
  • AUSTRALIA REGION? Use this Redirect URIs instead: https://api.yellowdig-au.app/lti3/unpack 
• Click "Save".

[IMPORTANT] If you're transitioning to LTI 1.3 from an old install of Yellowdig (LTI 1.1) we highly recommend giving the app installs unique names (EX: name old app install "Yellowdig 1.1 (legacy)" and the new "Yellowdig 1.3"." 

By default, the tool Title and the tool Description are both "Yellowdig".  To edit that name, click the pen icon to edit the LTI Key you just created. Select Manual Entry from the dropdown. From there, you can change both fields to "Yellowdig 1.3" and click Save. 

STEP 3

Send your client ID and entire Canvas domain in the Yellowdig Integration form. (Request the Yellowdig integration form through support)

• Your entire Canvas domain
  • (EXAMPLE: https://my_institution.instructure.com)
• Your newly created client ID.
  • This value is in the table on the Developer Keys page under the column "Details". (see image below)

• [IMPORTANT – Sub-account deployments]
  If you are installing Yellowdig at the sub-account level, you must include both of the following in your integration form or support request:

• The Deployment ID

• The sub-account name/identifier (add as a note in the integration form, e.g., "College of Law", "Business School")

  Deployment IDs are not always visible to our team unless explicitly shared, and sub-account names alone may not be sufficient to uniquely identify the correct placement. Providing both ensures we can accurately map your Canvas placement to the corresponding Yellowdig sub-organization and avoid delays in provisioning.

Once we’ve received your client ID, Canvas domain, and (if applicable) your Deployment ID and sub-account name, we will provision the integration on our side and let you know once you’re all set.

Root Level App Placement (most common)

After completing the setup steps above and getting confirmation from Yellowdig support, you can follow the steps below to add Yellowdig at the root level of your Canvas course page.  The steps below enable a one-time setup of Yellowdig so you won't need to reinstall the app with each new course / semester.

1. Copy the Client ID created in the steps above.
2. Navigate to Admin - Settings - Apps - View App Configurations - +App.
3. Select Configuration Type: By Client ID.
4. Paste the Client ID and click Submit.
5. Verify and install the Yellowdig app by clicking Install.

Next, the learning designer or instructor for the course(s) will follow the instructor setup guide here to get Yellowdig to display to your instructors and learners.

Sub-Account Level App Placement

Same setup as a root level placement, but add the app in the relevant sub-account instead.

Deployment ID and sub-account identification are both required to correctly map your Canvas sub-account placement to the corresponding Yellowdig sub-organization.

When submitting your integration request, make sure to include:

• The Deployment ID of the placement
• The sub-account name/identifier (included as a note in the integration form, e.g., "College of Law", "Business School")

For example, if you're making a placement for the Business School at your institution, you must provide both the Deployment ID and the sub-account name/identifier (included as a note in the integration form). This ensures that any LTI launches from that placement are correctly mapped to the appropriate Business School sub-organization in Yellowdig.

Deployment IDs alone do not always provide enough context, and sub-account names alone may not be uniquely identifiable from our side. Providing both ensures accurate and timely provisioning.

How to get your Deployment ID?

On the External Apps page where you placed your install of Yellowdig, click the Gear icon -> Deployment ID. That will reveal the Deployment ID, which you can copy and send to Yellowdig Support through your integration form or via a support ticket to support@yellowdig.com. (Request the Yellowdig integration form through support)

Course Level App Placement

After completing the setup steps above and getting confirmation from Yellowdig support, you can follow the steps below to add Yellowdig at the course level.  The steps below are for those who prefer to do a manual install of Yellowdig each time it is added to a new course and/or each time a new semester begins.

1. Copy the Client ID created in the steps above.
2. Navigate to Courses - Select the Course - Settings - Apps - View App Configurations - +App.
3. Select Configuration Type: By Client ID.
4. Paste the Client ID and click Submit.
5. Verify and install the Yellowdig app by clicking Install.

Yellowdig will now be enabled for use in only this one course.  Next, the learning designer or instructor for the course(s) will follow the instructor setup guide here to get Yellowdig to display to your instructors and learners.

Please provide your feedback about this article.

Submit your feedback here. We value your time to share your thoughts.

FAQ Section

Audience: This help article is for Yellowdig Organization Administrators. Users without this level of permission will not have access to these settings. Students, learners, and most instructors cannot access these settings.