Canvas LTI 1.3 - Installation Guide

Canvas users can integrate Vevox seamlessly using LTI 1.3 for a smooth in-class polling and engagement experience.

1. In your Vevox dashboard go to Account > Admin Settings > LTI.
2. Select 'Create New' and choose 'Add new plattform'.
3. In 'Platform name', give your plattform a name. (E.g. Canvas)
4. You should see a screen like the one in the below image, we will need this information later.
   
5. Within Canvas go to ‘Admin > Developer Keys.
   
6. Select +Developer Key and choose LTI Key.
   
7. On the Key setting page fill in the following details:
   • Redirect URIs: copy the 'Vevox target link' link from the LTI deployment section in your Vevox dashboard
   • Method: Manual entry
   • Title: Vevox (or however you would like the name to appear within Canvas)
   • Target Link URI: copy the 'Vevox target link' link from the LTI deployment section in your Vevox dashboard
   • OpenID Connect Initiation Url: copy the 'Vevox OIDC initiation URL' link from the LTI deployment section in your Vevox dashboard
   • JWK Method: Public JWK URL
      
   • Public JWK URL: copy the 'Vevox JWKS URL' link from the LTI deployment section in your Vevox dashboard
     
      

8. In the LTI Advantage Services section, turn on 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 assignments associated with the tool.

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

     The Can retrieve user data associated with the context the tool is installed in is required if you want students to access Vevox directly via vevox.app or the QR code in Present view (instead of through the Canvas link) and have their grades passed back to the Canvas gradebook.
     To use this setup, Participant SSO must also be configured on your Vevox account.

     
     
      

9. In the Additional Settings section:

   • Under 'custom fields' add the following value - Context.id.history=$Context.id.history

     The $Context.id.history value is required if you are copying courses within Canvas and want to retain any Vevox links when the copy is made.

   • Make sure the 'Privacy Level' is set to Public
     
10. In the Placements section add placements for:
    • Link Selection
    • Assignment selection
11.  Under both of the sub setting for these placements be sure to select the option for LtiDeepLinkingRequest.
    
12. When finished press Save.
13. You should now see this has been added to the developer keys.  The number above the 'show key' button, highlighted in the image below, is your Client ID, make a note of this as we will need it later.  Makes sure the state is toggled ON
    
14. Under Admin > Settings > Apps (or Admin > Settings > Apps > View App Configurations depending on Canvas version), add Vevox as a new app:
    • Click the '+ App' button
    • Under Configuration Type select By client ID
    • Enter the Client ID from step 12 and press Submit
    • You should see a screen saying "Tool "Vevox" found for client ID XXXXXXXXX. Would you like to install it?" Press Install
15. Vevox should now be visible as an app under Admin > Settings > Apps > (or Admin > Settings > Apps > View App Configurations depending on Canvas version). Locate Vevox in the list and note the Deployment ID — you’ll need this in a later step.
    
16. Next we need to fill out the details in the Vevox LTI deployment screen from step 3.
    • ISS - If using cloud hosted solution provided by Instructure this is "https://canvas.instructure.com". If using cloud hosted test solution provided by Instructure this is "https://canvas.test.instructure.com". Consult your Canvas provider otherwise.
    • Client ID - This is the number found in step 12 above
    • Authorization endpoint - <your organization canvas URL>/api/lti/authorize_redirect (e.g. https://vevox.instructure.com/api/lti/authorize_redirect)
    • Token endpoint - <your organization canvas URL>/login/oauth2/token (e.g. https://vevox.instructure.com/login/oauth2/token)
    • JWKS endpoint - <your organization canvas URL>/api/lti/security/jwks (e.g. https://vevox.instructure.com/api/lti/security/jwks)
    • Deployment ID - This is the number found in step 14 above
      
17. When you have finished here press the SAVE button to save the details.
18. The setup should now be complete, and you will now be able to add Vevox to Assignments and Modules in Canvas.