Skip to main content

How to set up the Engageli LTI External Tool in Canvas LMS

This article will walk you through the process of setting up Engageli as an LTI tool within Canvas LMS.

Developer Key/External Tool Setup

The first step to the integration process is to set up the Engageli tool. This will allow Engageli to be used throughout your Canvas instance.

  1. As a Canvas Admin, navigate to the "Admin" > "Developer Keys" area of the platform, as shown below.

  2. Select the "+ Developer Key" button, then select "+ LTI Key" from the corresponding dropdown, as shown below.

     
  3. In the new page that opens, configure the fields at the top-half of the page as follows:
    • Key Name - Name this as you wish, we recommend including "Engageli" in the name for easy lookup if you need to edit this later on.
    • Redirect URIs - Engageli will provide these.
    • Method - Ensure this is set to "Manual Entry"
    • Title - Name this as you wish, preferably something that references Engageli. This is the label that faculty will see when scrolling through the list of external tools to add to their course.
    • Description - Use any description you wish.
    • Target Link URI - Engageli will provide this.
    • OpenID Connect Initiation Url - Engageli will provide this.
    • JWK Method - Set this to "Public JWK URL".
    • Public JWK URL - Engageli will provide this.
  4. In the LTI Advantage Services section, we recommend enabling every option. Engageli might not support every option at this time, but enabling all options now will save you from having to revisit this area in the event that we make enhancements. Screenshot below for reference.

     

  5. In the Additional Settings section, populate the "Custom Fields" box. Below is a list of all entries to add to this box: 

    term_name=$Canvas.term.name
course_roles=$Canvas.membership.roles
course_start_date=$Canvas.course.startAt
course_end_date=$Canvas.course.endAt
submission_end_date=$Canvas.course.endAt
assignment_requirements=attendance, poll
user_section_sis_id=$Canvas.course.sectionSisSourceIds

    For context, these are key-value pairs containing Canvas variables that will be passed to Engageli.

  6. In the Additional Settings section, ensure the Privacy Level flag is set to "PUBLIC"
  7. In the Additional Settings section, input 750 for Selection Height and 600 for Selection Width. This sets the default size of the deeplink modal window, when applicable.
  8. For the Placements field, select all the areas you wish for the Engageli tool links to be made available for inserting.
    In our example, we're going to add "Link Selection" as a placement, as shown below:

    Some fields related to the Link Selection placement will appear. They are all optional; below is our recommendation for certain fields:
    • Target Link URI & Message Type - While you can leave this pair of fields blank, you should set values for these to avoid ambiguous behavior. Decide whether this placement will send a deep link message or a resource link message and populate the URI accordingly.
  9. When done with placements, click the "Save" button at the bottom of the page.
  10. Back on the Developer Keys page, where all your keys are listed, look for the key you've just created and ensure it is enabled, by toggling the switch under the "State" column so that it shows green.

     
  11. Locate the Client ID value for your new tool by looking under the "Details" column, as shown below. You'll need to provide this value to the Engageli team.

You are now done with the setup. You will need to fill out the form below and send it to your Engageli representative, so that they can complete their end of the setup. We've pre-populated the form with helpful placeholder values.

  • Client ID - (can be obtained from the Developer Keys page you visited earlier)
  • URL/Issuer - https://canvas.instructure.com (leave this as-is, no change needed)
  • Authentication Endpoint - https://sso.canvaslms.com/api/lti/authorize_redirect (leave this as-is, do not change).
  • Access Token Endpoint - https://sso.canvaslms.com/login/oauth2/token (leave this as-is, do not change).
  • Authentication Configuration - JWKS hosted at https://sso.canvaslms.com/api/lti/security/jwks (leave this as-is, do not change).

Making Engageli Tool Available Globally

If you decide that you'd like to make the Engageli tool available to all courses, please continue with the below steps.

  1. Navigate to Admin > Developer Keys. Look for the entry you created earlier, then click on the "View in Canvas Apps" link under its "Details" column. Below is an example screenshot:

     
  2. In the new window with the app details loaded, click on the "Unlock app" button, as shown below:

     
  3. Once the app is unlocked, select the pencil icon near the bottom of the screen, as shown below:

  4. Change the status from "Not Available" to "Available", then hit "Save". Below is a reference image:

    You are now done; the Engageli app is available for all users in your organization.

Notes

Canvas has test environments. If LTI is being configured within these environments, the SSO-related domains for the earlier mentioned endpoints that you'll provide to Engageli should be updated accordingly:

  • Beta - For Canvas Beta environments, use sso.beta.canvaslms.com
  • Test - For Canvas Test environments, use sso.test.canvaslms.com

Related articles