How do I integrate OpenStax Assignable with Canvas?

Canvas LMS Integration for OpenStax Assignable (Cloud-hosted Canvas)

OpenStax Assignable Checklist

  • Coordinate with administrators who have developer or admin access to LMS settings.
  • Ensure compatibility with LTI 1.3.
  • Only production environments are supported. Beta, sandbox, and test environments are not compatible with Assignable.
  • Assignable only needs to be integrated once. Please double-check that the tool isn't already available in your LMS.
  • Complete all steps outlined in this help article.

Before Beginning

To get started, go to the Assignable LMS Integration page, click the down arrow, and select Canvas.

Assignable LMS Integration page showing the LMS dropdown menu with Canvas selected.

After selecting Canvas from the dropdown menu, copy the JSON URL (https://lti-gateway.openstax.org/api/v0/platforms/canvas) from the Assignable LMS Integration page, as shown below.

Note: Leave this page open. You will need to return to it in the final step to enter the Client ID.

Assignable LMS Integration page highlighting the JSON URL to copy.

In Canvas

  1. Log in to your Canvas account and navigate to Apps under the Admin option in the left navigation bar.

    Canvas left navigation bar with the Admin section expanded, showing the path to the Apps page.

  2. Click the Apps link in the menu.

    Canvas settings menu with the Apps link highlighted.

  3. On the Manage tab, click the Install a New App button.

    Canvas Manage tab showing the Install a New App button.

  4. Select Enter URL as the Install Method.

  5. Paste the JSON URL (https://lti-gateway.openstax.org/api/v0/platforms/canvas) from the Assignable LMS Integration page into the JSON URL field in Canvas and click Next.

    Install App dialog showing the Enter URL method selected with the JSON URL field.

  6. Add https://lti-gateway.openstax.org/lti/app to both the Redirect URI and Default Target Link URI fields.

  7. Add https://lti-gateway.openstax.org/lti/loginroute to the OpenID Connect Initiation URL field and click Next.

    LTI 1.3 Registration screen showing the Redirect URI, Default Target Link URI, and OpenID Connect Initiation URL fields.

  8. Verify that the required permissions are selected and click Next.

    Permissions verification screen with the required permissions checked.

  9. Verify that All User Data is shared with the app and click Next.

    Data sharing screen confirming that all user data is shared with the app.

  10. Choose Assignment Selection under Placements and click Next.

    Placements screen with Assignment Selection chosen.

  11. Choose LtiDeepLinkingRequest for the Assignment and Link Selections and click Next.

    Override URIs screen with LtiDeepLinkingRequest selected for Assignment and Link Selection.

  12. Choose an Administration Nickname, fill out the description, and click Next.

    Administration Nickname and description fields.

  13. Review the settings and click Update App.

    Settings review screen with the Update App button.

  14. In Developer Keys, copy the Client ID under "Details."

    Note: The Client ID will contain only numeric characters.

    Developer Keys page highlighting the Client ID under the Details column.

  15. In the Admin panel, go to Settings, choose Apps, and click View App Configuration.

    Admin panel showing the View App Configurations button.

  16. Click + App.

    App Configurations page with the + App button highlighted.

  17. On the Add App screen, choose By Client ID as the Configuration Type.

    Add App screen with By Client ID selected as the Configuration Type.

  18. Paste the Client ID and click Submit.

    Add App dialog with the Client ID field and Submit button.

  19. Return to the Assignable LMS Integration page and paste the Client ID. Click Save and Continue.

    Assignable LMS Integration page with the Client ID field and Save and Continue button.

  20. Proceed to the next screen and enter the information on the registration page. This will complete your LMS integration.

Next Steps

Once your organization has successfully integrated with Assignable, there's no need to repeat these steps. You're all set to create assignments. For the next steps, review the How do I create an OpenStax Assignable assignment in Canvas? help article.

Assignable