Canvas SSO
userXello Admin Xello productAccounts Time8 minutes

Xello can be added as an external application within Canvas for the purposes of SSO.

FYIFYI: To learn more about how SSO works in Xello, see the articles How Student SSO Works and How Educator SSO Works.

Your Onboarding Manager will provide you with two pieces of information to be used in a later step: a consumer key and a shared secret. The consumer key is our unique identifier for your Canvas implementation, while the shared secret is used to ensure that all communication sent from Canvas to Xello are secure. Both pieces of information are unique to your implementation and are known only by Xello and your Canvas administrator.

In this article

Set Up the Xello App in Canvas

Before Xello can be added to any courses, the app must be set up in Canvas by following these instructions:

  1. From the main dashboard, click one of the courses.
  2. Click the Settings link and then the Apps sub-link. Next, click View App Configurations.
  3. You’ll be taken to an External Apps page that lists all installed third-party applications. To add Xello, click the + App button.
  4. You’ll now be prompted to enter configuration details. The settings should be as follows:
  5. Form Field Value
    Configuration Type Manual Entry
    Name Xello
    Consumer Key (the consumer key that was sent to you via email)
    Share Secret (the shared secret that was sent to you via email)
    Launch URL (this URL is case sensitive)
    Privacy Public (very important!)
    Custom Fields If using StudentID for the identifier: studentid=$Canvas.account.sisSourceId
    If using email address for the identifier: lis_person_contact_email_primary
    Description Xello prepares people for their successful future by helping them define and plan their own unique journey. With Xello, users build self-knowledge, explore their options, and create an actionable plan.
  6. Once the configuration information has been entered, click Submit in the bottom right of the window.
    • You should now see the Xello application listed in the External Apps page. Once this is complete, you can add the Xello app to a course module.

arrow upBack to top

Add Xello to a Course Module

  1. From the course you want Xello to be accessible from, click the Modules link and then the + Module button in the top right corner of the screen.
  2. Name the module Xello. You should now see the Xello module listed.
  3. Add one item to the module by clicking on the + button.
  4. A window will prompt you for information on which item to add. Choose External Tool from the first dropdown menu, then click the Xello link. This will automatically populate the URL and Page Name, which can be left as-is. Make sure you check the Load in a new tab checkbox, as Xello cannot be run in an iFrame.
  5. Next, both the module and item need to be published so students can see it. Click the Publish icon on the module. Then click the Publish icon on the item. You’ll be able to tell that the module and the item are published because the “publish” icons should both be green.

arrow upBack to top

Add Xello to a Page (Optional)

This section is completely optional. If you’d like the Xello app to appear on any custom pages, please follow these steps:

  1. From the Pages link, click the + Page button.
  2. Enter a name for the page and any HTML or page content. To add a link to the Xello module, click the Modules button to the right of the screen and click the Xello link to insert the link on the page. When you’re finished, click Save and Publish.

arrow upBack to top

Test Xello as a Student

Once Xello has been set up in Canvas, it’s time to test it as a student:

  1. Log in to Canvas as a real student (someone who exists in your SIS and has been data-integrated into Xello).
  2. Click the course that contains the Xello module.
  3. Click the Modules link. Xello is listed as one of the modules. Click the link.
  4. Click Load Xello in a new window to be taken into Xello without having to enter a username or password.

If you run into difficulties or want a support technician to walk you through the above setup, please let your Onboarding Manager know and we’ll be more than happy to arrange a screen sharing session.

arrow upBack to top