Canvas Setup Guide
Canvas supports LTI 1.3 fully, so use it: teachers get a PrepareBuddy picker (language tests, quizzes, assessments), and each assignment gets its gradebook column automatically. You need a Canvas account administrator and a PrepareBuddy organization administrator.
LTI 1.3 (recommended)
1. Create the developer key in Canvas
- Admin → (your account) → Developer Keys → + Developer Key → + LTI Key.
- Key Name:
PrepareBuddy. Redirect URIs:https://www.preparebuddy.com/tasks/lti/launch/ - Method: Enter URL, and paste
https://www.preparebuddy.com/lti/config.json. This fills in the login URL, the public keyset, the placements (Assignment Selection and Link Selection for the picker; Course Navigation, hidden from students by default) and the grade-service scopes. - Save, then switch the key ON.
- Copy the number in the Details column — this is the Client ID.
2. Install it in your account
- Admin → Settings → Apps → View App Configurations → + App.
- Configuration Type: By Client ID. Paste the Client ID and Submit, then Install.
- Open the app's settings menu (⚙) → Deployment Id, and copy it.
3. Register Canvas in PrepareBuddy
On /lti/manage/ → LTI 1.3 · step 2:
| Field | Canvas cloud value |
|---|---|
| Issuer | https://canvas.instructure.com |
| Client ID | the number from step 1.5 |
| Authentication URL | https://sso.canvaslms.com/api/lti/authorize_redirect |
| Access token URL | https://sso.canvaslms.com/login/oauth2/token |
| Public keyset URL | https://sso.canvaslms.com/api/lti/security/jwks |
| Deployment ID | the value from step 2.3 |
Canvas test and beta environments use https://canvas.test.instructure.com / https://canvas.beta.instructure.com as issuer and sso.test.canvaslms.com / sso.beta.canvaslms.com in the three URLs. Self-hosted Canvas: use your Canvas address in place of both hosts, and check the issuer with your Canvas administrator.
4. Teachers add a test, quiz or assessment
Assignments → + Assignment → Submission Type: External Tool → Find → PrepareBuddy test. The PrepareBuddy picker opens; choose one and click Add to course. Canvas fills in the link and creates the gradebook column with the right maximum (e.g. 9 for IELTS, 100 for a quiz). Tick Load This Tool In A New Tab for the smoothest experience. See the Teacher Guide.
LTI 1.1 (only if you cannot use 1.3)
- On
/lti/manage/, create an LTI 1.1 key and copy the key and secret. - In Canvas: Admin → Settings → Apps → View App Configurations → + App.
Configuration Type: By URL; Consumer Key and Shared Secret from step 1; Config URL:
https://www.preparebuddy.com/lti/config/. Submit. - Teachers create an assignment with Submission Type: External Tool, paste the link URL (copied from the PrepareBuddy LMS integration page, e.g.
https://www.preparebuddy.com/lti/test/123/), tick Load This Tool In A New Tab, and set Points to the maximum shown next to it.
Check it works
Follow Step 3 — Try it in a sandbox course in the Administrator Setup Guide. Use a Canvas Student View or a test-student account.
Canvas-specific notes
- "Load This Tool In A New Tab": without it, Canvas shows a PrepareBuddy card inside the page with an Open PrepareBuddy button; with it, the student lands on the test directly. Both work.
- Email: Canvas sends the user's email only when the key's privacy level is public (the JSON configuration sets this).
- Multiple attempts: the gradebook keeps the student's latest PrepareBuddy score for that assignment.