T007 – Adding BookWidgets to Canvas as an LTI 1.3 Tool

This guide explains how a Canvas administrator can register BookWidgets as an LTI 1.3 (LTI Advantage) external tool using Dynamic Registration.

Before you begin:

- You need a Canvas account with account administrator rights (root account admin is recommended, so BookWidgets is available across all sub-accounts and courses).

Step 1: Request a Dynamic Registration link

Contact sales@bookwidgets.com to request an LTI Advantage Dynamic Registration link for your Canvas instance.

Step 2: Open the Developer Keys page

1. Log in to Canvas as an administrator.
2. In the global navigation, click Admin and select your account.
3. In the account navigation, click Developer Keys.

Step 3: Register BookWidgets with the Dynamic Registration link

1. Click + Developer Key and select + LTI Registration.
2. In the Dynamic Registration URL field, paste the Dynamic Registration link you received from BookWidgets.
3. Click Continue.
4. BookWidgets completes its part of the registration automatically. Canvas then shows its own review screens for permissions, data sharing, placements and naming. The default values are correct; click through the screens without changing them and finish the registration (for example with Enable & Close).

> Note: The Dynamic Registration link can only be used once. After it has been consumed, it cannot be reused, even if registration was interrupted or failed. If you need to register again, contact sales@bookwidgets.com for a new link.

Step 4: Enable the developer key and copy the Client ID

1. On the Developer Keys page, find the new BookWidgets key.
2. Make sure its State is set to On.
3. Copy the Client ID, the number shown in the Details column. You need it in the next step.

Step 5: Install BookWidgets in your account

1. In the account navigation, click Settings and open the Apps tab.
2. Click View App Configurations, then click + App.
3. Under Configuration Type, select By Client ID.
4. Paste the Client ID from Step 4 and click Submit.
5. Click Install to confirm.

Step 6: Test the integration

1. Open a test course and go to Assignments.
2. Click + Assignment, set Submission Type to External Tool, and click Find.
3. Select BookWidgets, pick or create a widget, and return to Canvas.
4. Save and publish the assignment, then open it as a teacher and as a test student to confirm that the launch works and that grades are passed back to the Canvas gradebook.

BookWidgets is now available to all teachers in your Canvas account.

Troubleshooting

• BookWidgets doesn't appear in courses: check that the developer key's State is On (Step 4) and that the app was installed by Client ID (Step 5).
• Registration failed or was interrupted: the link has already been used. Delete the incomplete developer key, if one was created, and request a new link from sales@bookwidgets.com.