Skip to main content

LTI 1.3 integration with Canvas - Setup Guide

Complete guide to connect and configure your LMS in minutes

Configure Wooclap as an LTI 1.3 tool

⚠️ You need to be logged in to your Canvas LMS as an admin or an account with admin rights

Using Dynamic Registration

⚠️ Before starting the Dynamic Registration process, make sure your Wooclap contact has provided you with a Configuration ID, as it will be required for the registration

Register the LTI 1.3 configuration on Canvas

1. Go to the menu item Admin > Your organization

2. In the Admin menu, go to the Developer Keys item, then click + Developer Key > LTI Registration

3. The following LTI 1.3 Dynamic Registration form will appear.

4. Fill in the required information in the form:

  • Configuration ID – The Configuration ID provided by your Wooclap contact for the Dynamic Registration.

  • Organization name – Your organization’s name.

  • Language – The default language used by your organization’s users.

  • Country – The default country assigned to your organization’s users.

  • Admin email – The email address of an administrator in your organization, so our team can contact you in case of an issue.

⚠️ If the Configuration ID has not yet been provided to you, contact your Wooclap representative to obtain it

5. A confirmation modal will appear once the form is submitted. Review the data, then click the Enable & Close button.

6. The Wooclap LTI 1.3 integration is now available to be installed as an app in Canvas.

Install Wooclap as an app

1. Go to the menu item Admin > Your organization

2. Then go to Settings > Apps and click the View App Configuration button

3. Click the + App button

4. In the Configuration Type list, select the By Client ID option

⚠️ You can retrieve this Client ID in your Developer Keys page

5. Confirm the install by clicking on Install button

6. The app Wooclap LTI 1.3 is now available in the list

7. To finalize the app installation and allow it to access Wooclap, you need to provide the Deployment ID to your Wooclap contact.

⚠️ Without this Deployment ID, Wooclap cannot finalize the integration with your Canvas LMS.

Using Manual Registration

1. Go to the Admin menu of your Canvas instance

2. Then select the main Site admin account

3. Click on the menu item Developer Keys

4. On the Developer Keys page, you need to create a new key by clicking the button + Developer Keys > LTI Key

Set up your instance

1. Fill in the data required for the Wooclap tool

Key Name

A unique name to identify your Wooclap tool integration in Canvas

Owner Email

Admin/integration owner email on your side

Redirect URIs

https://app.wooclap.com/api/lti13/launch

Method

Manual Entry

Title

The name you want to give to your integration (visible in your LMS)

Description

The description you want to give to your integration

Target Link URI

https://app.wooclap.com

OpenID Connect Initiation URL

https://app.wooclap.com/api/lti13/oidc

JWK Method

Public JWK URL

Public JWK URL

https://app.wooclap.com/api/jwks

2. Enable the required LTI Advantage Services to allow Wooclap sync with your LMS

3. Select the required Placements to make this integration visible in your tool and use it

Icon URL

https://s3-eu-west-1.amazonaws.com/tpd/logos/64133aca8b5fd75faaf53dcc/0x0.png

💡 Tip: You can adjust the default size of the Deep Linking Quicklink to:

  • Width: 1200

  • Height: 800

⚠️ Do not forget to enable the LtiDeepLinkingRequest option to have the best experience

4. To redirect students to the Canvas assignment when they scan a Wooclap event’s QR code, you need to add the following parameters under “Additional Settings” > “Custom fields”

base_url=$Canvas.api.baseUrl 
course_id=$Canvas.course.id
assignment_id=$Canvas.assignment.id

This is what the additional settings should look like

5. Make sure the Privacy Level is set to Public in the Additional Settings. This option is necessary for Wooclap to receive the email, first name, and last name of the user when accessing the activity.

6. Save your configuration

7. Back on the Developer Keys interface, enable your LTI 1.3 configuration

Make your Wooclap LTI 1.3 instance available in your LMS

1. Go to your Admin menu and select the organisation you want to install the LTI 1.3 Wooclap tool in

2. Go to the Settings menu item and then Apps

3. Add a new App

4. Select By Client ID for Configuration Type and provide the Client ID of your Wooclap LTI 1.3 configuration

5. You can retrieve this client ID in your Developer Keys page

6. Install the application

7. Your app is now installed and will be available in your LMS

Provide your integration details to Wooclap

⚠️ Once the Wooclap LTI 1.3 has been installed on your LMS, you need to provide your configuration details to the Wooclap team to finalize the integration. This will allow Wooclap to authorize incoming requests from your LMS

1. Provide the following information to your Wooclap contact

Platform ID

Your platform ID / LMS base URL (ex: https://canvas.instructure.com)

Client ID

Your integration Client ID (ex: 10000000000001)

Deployment ID

Your installation Deployment ID (ex: 1:8865aa05b4b79b64a91a86042e43af5ea8ae79eb)

Public keyset URL

Your public keyset URL (ex: https://your-platform-url/api/lti/security/jwks)

Access token URL

Your access token URL (ex: https://your-platform-url/login/oauth2/token)

Authentication request URL

Your authentication request URL (ex: https://your-platform-url/api/lti/authorize_redirect)

LMS URL

The LMS URL allows Wooclap to redirect participants back to their original course in the LMS once the session is over. In most cases, this redirect is handled automatically. However, some LMS platforms such as Canvas provide URLs that are difficult to use directly, making automatic redirection unreliable. In these cases, the LMS URL is explicitly requested to ensure participants are correctly redirected back to their course.

Here's an example of an email you can send to the Wooclap team to provide your registration information

Object : LTI 1.3 registration details - University name

Dear Wooclap CSM team,

Please find the LTI 1.3 registration details for "Your university name".

- Platform ID: XXX

- Client ID: XXX

- Deployement ID: XXX

- Public keyset URL: XXX

- Access token URL: XXX

- Authentication request URL: XXX

Best regards,

"Your name"

⚠️ Once you have sent the email with all the LTI 1.3 configuration details to your Wooclap contact, please wait until we get back to you confirming that we have registered your integration on our side.

Did this answer your question?