Canvas LMS

Learn more about each capsule of the Canvas LMS collection.

To access the Canvas LMS collection and use the features presented in this article, you need the permission PIPELINE:CREATE. Learn more in the documentation about Roles.

Canvas LMS is a capsule collection that allows you to perform some actions in a system created with the Canvas LMS platform.

The Canvas LMS platform is used by educational institutions and organizations to manage and deliver courses and educational content to students and learners.

Learn how each capsule of the collection works.

Canvas LMS capsules

Access Custom Data

With the Access Custom Data capsule from the Canvas LMS collection, you can search for user data, create or update user data, or delete a user from a system created with Canvas LMS. For more information, see Users API section in Canvas LMS API.

Take a look at the configuration parameters of the capsule:

Parameter	Description	Data type
Action	The action to be taken. The options are: Lookup, Create or Update, and Delete.	String
Canvas URL	The URL of the Canvas LMS.	String
Canvas Account ID	The ID of the Canvas LMS account.	Integer
Canvas User ID	The ID of the Canvas LMS user.	Integer
Data Namespace	The path for the location of the data itself, for example: colors/primary.	String
Data Scope	The path for the location of the data itself, for example: colors/primary.	String
Data	The data to be stored in the custom data.	JSON or Text
Canvas Auth Token	The Canvas LMS API Authentication Token.	String

Method types

• Lookup for user data: if you select the Lookup option in the Action parameter, a REST call is made to the API with a GET method and retrieves the user data via the ID.

• Create or update user data: if you select the Create or Update option in the Action parameter, a REST call is made to the API with a PUT method.

• Delete user data: if you select the Delete option in the Action parameter, a REST call is made to the API with a DELETE method and deletes the user data via the ID.

Find/Create User

With the Find/Create User capsule from the Canvas LMS collection, you can retrieve, create, edit, or delete a user from a system created with Canvas LMS. For more information, see the Users API section in Canvas LMS API.

Take a look at the configuration parameters of the capsule:

Parameter	Description	Data type
Action	The action to be taken. The options are: Get, Create, Edit, and Delete.	String
Canvas URL	The URL of the Canvas LMS.	String
Canvas Account ID	The ID of the Canvas LMS account.	Integer
Canvas Auth Token	The Canvas LMS API Authentication Token.	String
Payload	The body of the request, if necessary.	JSON

Method types

• Get user: if you select the Get option in the Action parameter, a REST call is made to the API with a GET method to retrieve a user via the ID or email.

• Create user: if you select the Create option in the Action parameter, a REST call is made to the API with a POST method to create a new user and pseudonym for an account.

• Edit user: if you select the Edit option in the Action parameter, a REST call is made to the API with a PUT method to edit an existing user via the ID.

• Delete user: if you select the Delete option in the Action parameter, a REST call is made to the API with a DELETE method to delete the user via the ID.

SIS Imports

With the SIS Imports capsule from the Canvas LMS collection, you can integrate an institution's Student Information Services (SIS) by providing Canvas LMS CSV files with user, course, and enrollment data. For more information, see the SIS Import API section in Canvas LMS API.

Take a look at the configuration parameters of the capsule:

Parameter	Description	Data type
Action	The action to be taken. The options are: Create import, Get import status, Get import error list, Cancel import, and Cancel all pending imports.	String
Canvas URL	The URL of the Canvas LMS.	String
Canvas Account ID	The ID of the Canvas LMS account.	Integer
CSV File	The local file to be updated. Learn more about SIS CSV Format.	String
Canvas Auth Token	The Canvas LMS API Authentication Token.	String
Payload	The body of the request, if necessary.	JSON

Method types

• Create import: if you select the Create import option in the Action parameter, a REST call is made to the API with a POST method to import SIS data to Canvas LMS.

• Get import status: if you select the Get import status option in the Action parameter, a REST call is made to the API with a GET method to retrieve the status of an already created SIS import via the ID.

• Get import error list: if you select the Get import error list option in the Action parameter, a REST call is made to the API with a GET method to retrieve the list of SIS import errors for an account or a SIS import.

• Cancel import: if you select the Cancel import option in the Action parameter, a REST call is made to the API with a PUT method to cancel a SIS import that has not been completed.

• Cancel all pending imports: if you select the Cancel all pending imports option in the Action parameter, a REST call is made to the API with a PUT method to cancel SIS imports that have already been created but not processed or are in process.

Terms

With the Terms capsule from the Canvas LMS collection, you can create, retrieve, edit, or delete enrollment terms. For more information, see the Enrollment Terms API section in Canvas LMS API.

Take a look at the configuration parameters of the capsule:

Parameter	Description	Data type
Action	The action to be taken. The options are: Get, Create, Edit, and Delete.	String
Canvas URL	The URL of the Canvas LMS.	String
Canvas Account ID	The ID of the Canvas LMS account.	Integer
Payload	The body of the request, if necessary.	JSON
Canvas Auth Token	The Canvas LMS API Authentication Token.	String

Method types

• Get term: if you select the Get option in the Action parameter, a REST call is made to the API with a GET method to retrieve a list of the enrollment terms in the account or a specific enrollment term via the ID.

• Create term: if you select the Create option in the Action parameter, a REST call is made to the API with a POST method to create a new enrollment term for the specified account.

• Edit term: if you select the Edit option in the Action parameter, a REST call is made to the API with a PUT method to update an existing enrollment term via the ID.

• Delete term: if you select the Delete option in the Action parameter, a REST call is made to the API with a DELETE method to delete the enrollment term via the ID.