Skip to main content

Setting Up LTI 1.3 for Canvas

A step-by-step walkthrough for connecting Canvas to Vocareum using the new Canvas Apps page.

R
Written by Rizzian Tuazon

For Admins

This guide describes how to set up a Learning Tools Interoperability (LTI) 1.3 connection between Canvas and Vocareum using Canvas's Apps page at the root account scope, then registering the resulting Client ID and Deployment ID in Vocareum at the organization level. The steps below are a one-time, root-level setup that must be in place before any individual Canvas course can connect to Vocareum.

If the Canvas-to-Vocareum integration is already installed and you only need to enable LTI within an existing Vocareum course, refer to Configure LTI 1.3 in Your Course instead. If you are an instructor adding Vocareum to a specific Canvas course (selecting a placement, mapping assignments for grade passback, or enabling Course Navigation), refer to Adding Vocareum to a Canvas Course instead.

Prerequisites

Before beginning, confirm that you have the access listed below.

  • Canvas Account Admin access for the root account, with the LTI Registrations - Manage and Developer Keys - Manage permissions enabled.

  • Vocareum Organization Admin (Org Admin) access.

Installing Vocareum in Canvas

The Canvas Apps page installs Vocareum from a JSON configuration URL, which pre-populates the registration fields, permissions, data sharing settings, placements, and override URIs. The default values are correct for standard Vocareum setups and can be edited later from the app's Configuration tab if needed.

Begin from Canvas's global navigation. The first four steps reach the Install a New App button.

Canvas Install App modal with LTI 1.3 selected, Enter URL chosen as the Install Method, the Vocareum JSON URL pasted into the JSON URL field, and the Next button highlighted.
  1. In the Canvas global navigation, click Admin and choose the account where Vocareum will be installed.

  2. In the account's left navigation, click Apps.

  3. On the Apps page, click the Manage tab.

  4. In the top right, click Install a New App. The Install App modal opens.

The next four steps configure the install method using the Vocareum JSON URL.

Alt text: Canvas Install App modal with LTI 1.3 selected, Enter URL chosen as the Install Method, the Vocareum JSON URL pasted into the JSON URL field, and the Next button highlighted.

5. Select LTI Version 1.3.

6. From the Install Method dropdown, choose Enter URL.

7. In the JSON URL field, enter the Vocareum configuration URL:

https://labs.vocareum.com/lti1.3/config.json

8. Click Next.

Step through the remaining modals in the install wizard, accepting the pre-populated defaults for registration, permissions, data sharing, placements, override URIs, nicknames, and icons. When the wizard completes, Canvas displays the new Vocareum app page.

Making Vocareum available

A newly installed app is set to Not Available at the account scope by default. The steps below set the root availability so that Vocareum can be used across the entire account. If you want Vocareum to be reachable only in specific sub-accounts or courses instead, an alternative approach is described in the next section; consider which path best fits your needs before completing the steps below.

Vocareum app page in Canvas with the pencil Modify availability icon on the Installed in [Account] row highlighted.

9. On the Vocareum app page, locate the Installed in [Account] row and click the pencil Modify availability icon at the right of the row. Note that this is the pencil icon, not the Add Exception button next to it. The Edit Exception modal opens.

Canvas Edit Exception modal with availability changed from Not Available to Available and the Save button highlighted.

10. Change the availability from Not Available to Available.

11. Click Save.

Optional: Limiting Vocareum availability to specific sub-accounts or courses

By default, the steps in the previous section, "Making Vocareum available," make Vocareum reachable across the entire root account in Canvas. If you want Vocareum to be reachable only in certain Canvas sub-accounts (sub-divisions of a Canvas root account, such as a department or program) or in specific courses, use the Add Exception button on the Vocareum app page to scope availability.

A common pattern is to leave the root Installed in [Account] row set to Not Available and add an Available exception for each sub-account or course that should have access. Exceptions are a Canvas-side access control mechanism: they constrain where the installed app appears to users without creating additional deployments. There is still one Vocareum Deployment ID, registered at the root scope.

Vocareum app page in Canvas showing the Installed in [Account] row set to Not Available, a child sub-account row also Not Available, and an Available exception added for a specific course.

To add an exception, click Add Exception on the Vocareum app page, select the target sub-account or course in the Add Availability and Exception modal, set its availability to Available, and click Save. For complete details on managing app availability and exceptions in Canvas, refer to Canvas' documentation: How do I manage app availability and exceptions in Canvas Apps?

Copying the Client ID and Deployment ID

The next section registers Vocareum's connection back to Canvas using two identifiers that Canvas generated during install: the Client ID and the Deployment ID.

Vocareum app page in Canvas with the Copy Client ID button at the top of the page and the Deployment ID under the Installed in [Account] row highlighted.
  1. At the top of the Vocareum app page, click Copy Client ID and store the value somewhere you can paste from later.

  2. On the Installed in [Account] row, locate the Deployment ID displayed beneath the account name and store it alongside the Client ID.

Registering the issuer and deployment in Vocareum

With the Client ID and Deployment ID copied, register Canvas as an LTI 1.3 issuer in Vocareum at the organization level. For the step-by-step procedure and the exact Canvas values to enter, refer to Registering an LTI 1.3 Issuer and Deployment in Vocareum.

Next steps

With the root-level integration in place, instructors can now add Vocareum to individual Canvas courses, choose a placement, and optionally map assignments for grade passback. For the instructor-facing walkthrough, refer to Adding Vocareum to a Canvas Course.

Existing LTI integrations

Existing LTI 1.3 integrations set up via the legacy Canvas Developer Keys or By Client ID flow continue to work. New Canvas setups should use the steps above. If you maintain a legacy integration and need support, contact Vocareum support.

Did this answer your question?