Articles in this section

GivePulse Integration LTI 1.3 in Canvas

GivePulse Team
  • Updated
Follow

Integrating external tools such as GivePulse can greatly enhance the functionality and learning experience within Canvas. If you're looking to integrate GivePulse with Canvas using LTI 1.3, this comprehensive guide will walk you through the process step-by-step. From configuring the LTI Key settings to adding GivePulse as an app in Canvas, we can ensure that you have a smooth and seamless integration of the two applications. 

This article will cover:

Note: Deeplinking is currently not supported in 1.3 integration, it is on the future roadmap. 

Setting up GivePulse to Canvas

1. First, go to your group’s Admin dashboard.
step1.png

2. Click on 'More Tools' and then 'LTI.'Step2.png

 

3. You will then see the below LTI Configuration screen. 

  • Note: There is no need for LTI key and secret if you are using LTI Version 1.3.

step3.png

 

 

 

4. Use a different browser window/tab to log into Canvas as an admin. Navigate to the Admin section:

 

5. Navigate to 'Developer Keys' in the navigation.

 

6. Click on Developer Key and select LTI Key.

7. Fill in the Key Settings information.

    • a. Key Name - Set to GivePulse
    • b. Redirect URIs - Copy the value from the OIDC Redirect URL field in GivePulse. Paste the value in the following fields in Canvas.
    • c. Target Link URI - Same as Redirect URI.
    • d. Method - Choose Manual Entry.
    • e. Title Set to GivePulse.
    • f. Description - GivePulse.
    • g. OpenID Connect Initiation Url - Copy the OIDC Connect Initialization URL out of GivePulse. Paste the value in the following field in Canvas.
    • h. JWK Method - Choose Public JWK URL.
    • i. Public JWK URL - Copy the Keyset URL out of GivePulse. Paste the value in the following field in Canvas.

8. In the LTI Advantage Services section, you want to check everything to ON.



9. Copy the Domain value out of GivePulse. Paste the value In the Domain field in the Additional Settings section. (Please be sure to remove the slash / at the end of the URL - You will receive an error if included.)

10. Make sure the Privacy Level is set to Public.

11. In the Placements section, click the drop-down menu and choose Course Navigation to add it in.

12. Click the Save button.

13. In the Developer Keys list, find the key we just set up and toggle the State to ON, and copy the value (Client ID) in the Details column.

14. Copy the value of the Key from the Show Key button under Client ID. Paste this value in the GivePulse configuration for both the application key and secret.
developer-keys.png

Adding the Givepulse App to Canvas

In Canvas, go to the account, subaccount, and/ or course that you’d like to be available in as an LTI 1.3 app.

Account (Root) Level Set up:

The steps below enable a one-time setup of GivePulse so you won't need to reinstall the app with each new course/semester.

    1. Navigate to Admin - Settings - Apps - View App Configurations - +App.

    2. Select Configuration Type: By Client ID and enter the Client ID of the Developer Key (from the previous step).

    3. Click Submit and save your Deployment ID for a later step.

 

Sub-Account Level Set up:

Same setup as a root level placement, but add the app in the relevant sub-account instead.

Course Level App Placement

The steps below are for those who prefer to do a manual install of GivePulse each time it is added to a new course and/or each time a new semester begins.

  1. Navigate to Courses - Select the Course - Settings - Apps - View App Configurations - +App.

  2. Change Configuration Type to By Client ID by clicking the drop-down menu. Paste in the Client ID value we copied in the above step.
  3. Click Submit, click Install, and save your Deployment ID for a later step.

GivePulse Configuration

Go back to the GivePulse Configuration browser window/tab and fill in:

  1. Client ID - Paste the Client ID value we copied in the above step.
  2. Deployment ID - Paste the Deployment ID value copied in the above step.
  3. Application Key and Secret - Paste the Key value copied in the above step.
  4. OIDC Issuer - Set to https://canvas.instructure.com.
  5. Auth Request Endpoint - Set to https://canvas.instructure.com/api/lti/authorize_redirect.
  6. Keyset URL - Set to URL like https://<your-canvas-domain>/api/lti/security/jwks. For example, if your canvas domain is https://example.instructure.com, then you should fill in https://example.instructure.com/api/lti/security/jwks.
  7. Auth Token Endpoint Set to URL like https://<your-canvas-domain>/login/oauth2/token.
  8. Click Save

How to make the GivePulse LTI app hidden/disabled by default

Following this process, the tool will be set to be hidden by default in the course navigation. After the LTI has been fully installed, navigate back to the Developer Keys page and select 'Edit' for the GivePulse integration. Change the configuration method to 'Paste JSON' to access the entire integration code, which includes information about the tool's placement in the course navigation.

 

Review the highlighted additions in red below; copy and paste those 2 lines in the given course_navigation placement code fragment.

 

Please note that direct text editing on the Canvas page is not supported. 

 

 

 

If you have any questions, please Submit a Support Ticket.

Related articles

Comments

0 comments

Article is closed for comments.