T005 – Adding BookWidgets to Schoology as an LTI 1.3 Tool

This guide explains how a Schoology administrator can register BookWidgets as an LTI 1.3 (LTI Advantage) external tool using manual registration.

Before you begin:

• You need a Schoology account with System Administrator rights.

Step 1: Request the JWKS URL

Contact sales@bookwidgets.com to request the BookWidgets JWKS URL for your Schoology instance. Mention your school or organization name and your Schoology URL.

Step 2: Create the BookWidgets app

1. Log in to Schoology as a System Administrator.
2. Go to App Center → My Developer Apps and click Add App.
3. Fill in the form:

• App Name: BookWidgets
• Check This app uses cookies
• Type of App: LTI 1.3 App
• Can be installed for:
  • Select App center menu
  • Select User profile navigation, and overwrite Domain/URL with https://www.bookwidgets.com/lti/account
  • Select Left Navigation, and overwrite Domain/URL with https://www.bookwidgets.com/lti/results
  • Select Course Materials Selection, and overwrite Domain/URL with https://www.bookwidgets.com/lti/create
  • Select Rich Text Editor, and overwrite Domain/URL with https://www.bookwidgets.com/lti/create
• Privacy: select Send Name and Email/Username of user who launches the tool.
• LTI Advantage Selection: select Assignment and Grade Services and Names and Roles Services.
• JWKS URL: enter the JWKS URL you received from BookWidgets in Step 1.
• Domain: www.bookwidgets.com   
• OIDC Login Init URL: https://www.bookwidgets.com/lti/login   
• Redirect URLs: https://www.bookwidgets.com/lti/return       

4. Submit the form.

Step 3: Copy the Client ID

1. In My Developer Apps, open the BookWidgets app.
2. Click API Info and copy the Client ID. You need it in Step 6.

Step 4: Install the app for your organization

1. On the BookWidgets app, click Install LTI 1.3 App.
2. Click I agree, then Continue.
3. Choose Add to Organization. You are redirected to the Organization Apps page.

Step 5: Copy the Deployment ID and make BookWidgets available to courses

1. On the Organization Apps page, find BookWidgets and click Configure.
2. Copy the Deployment ID. You need it in Step 6.
3. Back on the Organization Apps page, click Install/Remove next to BookWidgets.
4. Select All Users, unselect Parent and Student (ensure only System admin and Teacher are selected)
5. Select All Courses. Do not select Course Admins Only, so all teachers can use BookWidgets.
6. Click Submit.

Step 6: Send the Client ID and Deployment ID to BookWidgets

Email the Client ID (Step 3), the Deployment ID (Step 5) and your Schoology URL to sales@bookwidgets.com. BookWidgets will complete the registration and confirm when the integration is ready.

Step 7: Test the integration

1. Open a test course and click Add Materials.
2. Select BookWidgets, pick or create a widget, and return to Schoology.
3. Open the material as a teacher and as a test student to confirm that the launch works and that grades are passed back to the Schoology gradebook.

BookWidgets is now available to all teachers in your Schoology organization.

Troubleshooting

• BookWidgets doesn't appear under Add Materials: check that Course Materials Selection is selected (Step 2) and that BookWidgets was installed for All Courses without Course Admins Only (Step 5).
• Launching BookWidgets shows a registration error: check that BookWidgets has confirmed your Client ID and Deployment ID (Step 6), and that the JWKS Endpoint matches the URL you received in Step 1.
• BookWidgets can't identify the user: check that the app's privacy setting is Send Name and Email/Username (Step 2).