How do I configure an External App for a course using XML?

Canvas recently introduced a new page design called the New Canvas User Interface (UI). Depending on your Canvas view, your page design may vary from the images shown in this lesson. However, the functionality and location of the components remain the same.

One way to configure an app for a course is by using XML.

To learn more about configuring external apps, visit the Edu App Center.

Open Settings

Open Settings

In Course Navigation, click the Settings link.

Open Apps

Open Apps

Click the Apps tab.

View App Configurations

View App Configurations

To configure an app, click the View App Configurations button.

Add New App

Add New App

Click the Add App button.

Set Configuration Type

Set Configuration Type

Select the Configuration Type drop-down menu and set the configuration type to Paste XML.

Add App Details

Add App Details

Enter the name of the App in the name field [1]. Enter the consumer key in the consumer key field [2] and the shared secret in the shared secret field [3]. This key and shared secret will be provided by the vendor or (if using the Edu App Center) provided by the website.

Note: There are some Apps that do not require a consumer key or shared secret, so pay attention to the configuration directions.

Enter Configuration XML

Enter Configuration XML

Copy the XML code in the paste XML here field [1]. Click the Submit button to link the App [2].

View App

View the linked App.

To edit, see the placements, or delete the app, click the Settings icon [1]. To edit the app, click the Edit link [2]. To see the placements where an app can be enabled, click the Placements link [2]. To delete the app, click the Delete link [4].