Instruqt Docs
  • 🚩Getting started
    • Overview
    • Setting up
      • Study Room
    • Quickstart
  • 🛤️Tracks
    • Manage tracks
      • Create tracks
      • Edit locally
      • Test tracks
      • Track logs
      • Track time limits
      • Track feedback
      • Developer workflow
      • Track tags
      • Track authors
      • Delete tracks
      • Custom layouts
      • Version control
      • Loading experience
    • Challenges
      • Create challenges
      • Challenge tabs
      • Challenge order
      • Skip challenges
      • Add quizzes
      • Assignment display
      • Assignment editor
    • Share tracks
      • Live Events
        • Instructor tools
      • Track invites
      • Embed tracks
      • Landing pages
  • 🏖️Sandboxes
    • Overview
    • Sandbox hosts
      • Add hosts
      • Custom VM images
      • Custom container images
      • Public images
      • Windows VMs
      • Website service
      • SSL certificates
    • Cloud accounts
      • Securing your cloud accounts
      • Cloud Client
      • AWS accounts
        • AWS Environment Variables
        • AWS Managed Policies
        • AWS IAM Policies
        • AWS SCP Policies
      • Azure subscriptions
        • Azure Environment Variables
        • Azure Roles
        • Azure Resource Providers
      • GCP projects
        • GCP Environment Variables
        • GCP IAM Permissions
    • Lifecycle scripts
      • Scripting overview
      • Track scripts
      • Challenge scripts
      • Example scripts
      • Helper scripts
    • UI Checks
    • Global Sandbox Settings
      • Hot start
      • Sandbox presets
      • Custom resources
      • Cloud services and regions
        • Allowed services and regions
    • Secrets and variables
      • Runtime variables
      • Runtime parameters
      • Secrets
  • ⚙️Settings
    • Integrations
      • Salesforce (Beta)
      • HubSpot (Beta)
      • HubSpot (Using zapier)
      • LTI
      • Version control
        • GitHub
    • Authentication
      • SSO
      • API keys
    • Platform
      • API
      • Webhooks
      • Track limits
  • 💡Reference
    • Feature overview
    • Instruqt CLI
      • Commands
      • Configuration files
      • Assets
    • Instruqt platform
      • Networking
      • Host machine types
      • Quotas and limits
      • Roles and permissions
      • Network access
      • Requirements
  • 🛟Resources
    • Content design tips
    • Advanced use cases
    • Templates
    • FAQ
      • Running Windows Client Hosts on Instruqt
      • Using Cleanup Scripts in SaaS and Cloud Environments
      • Instruqt Regional Configurations and Restrictions
      • Troubleshooting Instruqt CLI Authentication Issues
      • Copy a Track from One Organization to Another via CLI
      • Network Configuration: IP and MAC Address Control
      • Container Troubleshooting in Instruqt
Powered by GitBook
On this page
  • Overview
  • LTI version 1.1
  • Step 1: Integrate an Instruqt track
  • Video Tutorial
  • LTI version 1.3
  • Step 1: Integrate an Instruqt track
  • Step 2: Register your LMS as a Tool Consumer

Was this helpful?

Edit on GitHub
  1. Settings
  2. Integrations

LTI

Learn how to integrate Learning Tools Interoperability (LTI) with Instruqt.

Overview

This guide explains how to integrate Instruqt tracks within an LTI 1.1 and LTI 1.3 compliant learning management system (LMS).

Instruqt offers LTI integrations using the LTI 1.1 specification with LTI Basic Outcomes for result feedback, as well as the LTI 1.3 specification with the Assignment and Grading service for result feedback.

Scoring is done on completion of a track, where the result given is always a score of 1.0 or (100%). Meaning a track can either be complete or incomplete. More precise scoring is not supported at this point in time.

Most major LMS platforms such as Moodle, Thought Industries and Canvas support LTI 1.1 and LTI 1.3. Follow the steps below to integrate one of your Instruqt tracks with your LMS of choice.

To get started a unique Consumer Key and Consumer Secret will need to be generated for your team. This step is only required once and the same credentials can be used across tracks and LMS platforms.

When LTI credentials are generated a new webhook with the endpoint https://lti.instruqt.com/webhook will automatically be created, this is needed to provide basic outcomes feedback to consumer tools.

  1. Click Settings → API keys

  2. Under the LTI Credentials section, click Generate credentials. ↳ You will have the ability to regenerate credentials later on.

When credentials are regenerated all existing integrations with the old credentials will need to be updated or they will cease to work.

LTI version 1.1

Step 1: Integrate an Instruqt track

Once LTI credentials have been generated, tracks will each have a unique lti.instruqt.com URL. This URL is visible through the Web UI.

  1. Click the track you want to integrate.

  2. Click Share at the top of the page, and select LTI integration from the dropdown.

  3. Copy the URL and the consumer key + secret to your LMS LTI 1.1 configuration section.

LMS call these values different things. They are most commonly named Tool URL, Consumer Key, and Secret Key.

Keep your Consumer Key and Secret Key safe, exposing these credentials could lead to unwanted plays on your Instruqt tracks.

Video Tutorial

Not one for words? Heres a video tutorial demonstrating LTI integration.

LTI version 1.3

Step 1: Integrate an Instruqt track

Once LTI credentials have been generated, you will need to configure Instruqt as a Tool Provider on your LMS. All configuration details for a specific track can be found on the web UI.

  1. Click the track you want to integrate.

  2. Click Share at the top of the page, and select LTI integration from the dropdown.

  3. Copy the required details from the LTI 1.3 configuration section to your LMS. The LMS will will require the Tool URL, the Login URL and either the Public Key or the Public Key Set URL for authentication.

LMS call these values different things. They are most commonly named Tool URL or Redirection URL, Initiate login URL, and Public Keyset URL. ** The Tool URL should be added as one of the Redirect URI's when configuring the track on your LMS.

Below is an example of configuring an instruqt track as an LTI 1.3 external tool on the Moodle LMS:

Step 2: Register your LMS as a Tool Consumer

Once the Instruqt track has been configured on your LMS, the LMS will need be configured as a Tool Consumer on the Instrqut platform. This can be done using the Web UI.

  1. On the side menu, under Settings, click the LTI integratons item.

  2. Click Add on the top-right of the page.

  3. Copy the required details from your LMS into the LTI Tool Registration form. The following details are needed:

    1. Name - This can be any name as it is only used to display the configuration on the Instruqt LTI integrations page.

    2. Client ID - This is an unique ID that is used for authorisation and should be provided by your LMS.

    3. Issuer - Platform/Issuer ID of the LMS, generally the URL of the LMS.

    4. Key Set URL - The Public Key Set URL used to fetch a Public Key from the LMS.

    5. Public Key - The raw Public Key provided by the LMS if providing a Key Set URL is not supported.

    6. Access Token URL - An Access Token URL provided by the LMS, used for authentication.

    7. Auth URL - An Authentication request URL provided by the LMS, used for authentication.

    8. Deployment ID's - Each Tool configuration will have a unique deployment ID provided by the LMS once configured. If the Client ID and Issuer are the same for multiple tools on your LMS and only the deployment ID differs, only one LTI integration needs to be configured on Instruqt with a list of the Deployment ID's.

  4. Click Save on the top-right of the screen.

Either a Key Set URL or a Public key must be provided, it is not required to have both

Once you have done the configuration on both your LMS and the Instruqt platform you should have the track available for use in your lessons.

Below is an example of adding the Tool Configuration from the Moodle LMS to Instruqt as an LTI integration:

PreviousHubSpot (Using zapier)NextVersion control

Last updated 9 months ago

Was this helpful?

Currently Instruqt only supports and the . and the have not been implemented yet.

⚙️
Resource linking
Assignment and Grading Services
Deep Linking
Names and Role Provisioning Services
Example tool configuration on the Moodle LMS
Example tool configuration details from the Moodle LMS
Example configuration of a Moodle integration on Instruqt