Note: LTI 1.3 is currently in Beta. Please contact email@example.com if you are interested in participating in the beta.
This document contains the steps that a Blackboard administrator will need to perform to configure LTI 1.3 when using zyBooks. This must be performed by the Blackboard administrator since an instructor does not have the required privileges!
Creating the LTI 1.3 Tool
To create a LTI 1.3 tool for Blackboard, go to the Blackboard Developer Portal at https://developer.blackboard.com/ and login to your account. If you do not currently have an account, create one and log in.
When logged into the developer portal, you will see the following page. Click the + button towards the right hand side of the screen to create a new LTI 1.3 tool.
Enter a name, description, and domain for the application. The name and description are arbitrary and the domain must be lti1-3.zybooks.com.
Be sure to toggle “My integration supports LTI 1.3” and fill in the following fields then click “Register application and generate API key”.
Login Initiation URL: https://lti1-3.zybooks.com/v1/lti1p3/oidc
Tool Redirect URL(s): https://lti1-3.zybooks.com/v1/lti1p3/provider
Tool JWKS URL: https://lti1-3.zybooks.com/v1/lti1p3/jwks
On the next page, you will be presented with several pieces of information. Record these values and for later reference and click “Done”.
The Manage Your Applications page will be shown along with the new tool you created. Record the Application ID (821c02de-1beb-477b-aba4-1ecbfb2fb6d7 in the image below) and send this value to zyBooks support to allow your tool access to zyBooks.
Providing the LTI 1.3 Tool to Instructors
As an administrator, log into Blackboard and select the “System Admin” tab in the upper right corner.
Under Integrations, click LTI Tool Providers.
Next, open the “Register LTI 1.3 Tool” tab.
Enter the Application ID you recorded earlier into the “Client ID” field then click the green “Submit” button.
You will be presented with the settings for the new LTI 1.3 tool as shown below.
Scroll down and ensure that the following fields are set then click the green “Submit” button.
User Fields to Send: “Constituency in Course”, “Name”, and “Email Address”.
Allow evaluation service access: Yes. This is critical for grade passback to work with your zyBook.
Allow Membership Service Access: Yes.
You will be brought back to the LTI Tool Providers page. Scroll through the list of tools to find LTI 1.3 tool and click on the arrow next to the tool name. Then click Manage Placements.
In the upper left, click “Create Placement”.
Provide a label and tag for the tool that will be displayed when adding a LTI 1.3 assignment. This will be the name shown to instructors at your institution. Also fill in the following fields.
Type: Select Course content tool and Allows evaluation. Deselect all other fields.
Launch in New Window: Optionally set this if you want LTI launches to appear in a new tab.
Tool Provider URL: Enter https://lti1-3.zybooks.com/v1/lti1p3/provider
The placement will be added and the LTI 1.3 tool will be accessible to instructors.
Lastly, on the LTI Tool Providers page find the LTI 1.3 tool and select Edit.
Find the Deployment ID of the tool and send this to zyBooks support to configure access.
Instructors may create a new LTI 1.3 link by visiting the content pane of their course and selecting the LTI 1.3 tool as shown below. The linking process is exactly the same as with previous versions of LTI.