Skip to main content

How do I create the Soomo Canvas developer key?

LMS administrator instructions for creating the Soomo Canvas developer key

Written by Soomo Instructor Support

Overview and video tutorial

This article provides instructions for LMS administrators using Canvas instances not hosted by Instructure and/or those who do not wish to use Instructure-inherited Developer Keys. (If this does not apply to you, please proceed to our guide, How do I deploy Soomo’s Canvas app?)

To learn more about how this integration works, visit our article, How do I set up an LMS (Canvas, Blackboard, etc.) integration with Soomo?

If you have any questions while creating the Soomo Canvas developer key, please don’t hesitate to contact our LMS specialist at lms@soomolearning.com. You can also download a PDF version of these instructions.


1. Create the developer key

Tip: You can also follow Canvas’s official guide with step-by-step instructions and screenshots: How do I configure an LTI key for an account?.

To get started, log in to Canvas as an admin. From there, access the Admin tab and select Developer Keys in the left sidebar. Click Add Developer Key and select LTI Key from the drop-down menu. Input the values from the table below.

Key Name

Soomo Webtext LTI Key

Owner Email

Redirect URIs

Notes

[Leave blank]

Method

Manual entry

Title

Soomo Webtext LTI Key

Description

The Developer Key for the Soomo Learning Integration

Target Link URI

OpenID Connect Initiation URL

JWK Method

Public JWK URL

Public JWK

2. Set the LTI advantage services

Next, open the LTI Advantage Services expanding menu and check the following options:

  • Can create and view assignment data in the gradebook associated with the tool

  • Can view assignment data in the gradebook associated with the tool

  • Can view submission data for assignments associated with the tool

  • Can create and update submission results for the assignments associated with the tool

  • Can retrieve user data associated with the context the tool is installed in

  • Can view Progress records associated with the context the tool is installed in

3. Set the additional settings

Next, open the Additional Settings expanding menu and in the Custom Fields add:

  • canvas_user_id=$Canvas.user.id

  • canvas_course_id=$Canvas.course.id

Leave the remaining text boxes blank and then set Privacy Level to Public.

4. Select placements

Next, open the Placements drop-down menu and select the following:

  • Link Selection

  • Assignment Selection

5. Set placements to LtiDeepLinkingRequest

Finally, open the Link Selection and Assignment Selection expanding menus and do the following for both:

  • Leave all text boxes blank

  • Check LtiDeepLinkingRequest

Next steps

You can now proceed to the Canvas App Creation instructions to add the App for the developer key you just created.


If you have any questions, click the Soomo Messenger button in the lower-right corner. You can also contact us using the information below.

(888) 240-0314
Monday–Friday 9 a.m.–9 p.m. ET
Saturday–Sunday 1 p.m.–9 p.m. ET
support@soomolearning.com

Did this answer your question?