What Live Events extensions can I subscribe to in the Canvas Data Portal?

Document created by Emily Allen Employee on Feb 14, 2018Last modified by Erin Hallmark on Mar 31, 2018
Version 3Show Document
  • View in full screen mode

As an admin, when you subscribe to a Live Event in the Canvas Data Portal, you can select extensions that allow you to view additional information about that event.

 

These additional extensions provide a listing of the actual data you can expect to receive from selecting one of those subscriptions and whether it is valid. Please note that extensions are formatted as one word, with the first letter of the object lowercase and the first letter of any subsequent actions upper case. For example, the extension for information pertaining to a Discussion topic being created is discussionTopicCreated

 

Note: If you do not have access to the Canvas Data Portal in your account, please contact your Customer Success Manager.

 

Results are returned in JSON format, for example:

{

"my_data": "my_key",

"extensions: {

      "assignmentUpdated": {

            "actor": "user_id"

             "object": "assignment_id",

             "group": "assignment_group_id"

              }

      }

}

 

 

Events are grouped by one of six currently available Profiles - base, forum, session, outcome, reading, or assessment. Profiles categorize a learning activity or a supporting activity that helps facilitate learning. 

 

Base Profile: indicates a generic event or an event that is not specific to a certain profile

 

Attachment Created

attachmentCreated.actor

attachmentCreated.object

Attachment Updated

attachmentUpdated.actor

attachmentUpdated.object

Attachment Deleted

attachmentDeleted.actor

attachmentDeleted.object

attachmentDeleted.group

Enrollment Created

enrollmentCreated.actor

enrollmentCreated.object

enrollmentCreated.group

Enrollment Updated

enrollmentUpdated.actor

enrollmentUpdated.object

Enrollment State Created

enrollmentStateCreated.actor

enrollmentStateCreated.object

enrollmentStateCreated.group

Enrollment State Updated

enrollmentStateUpdated.actor

enrollmentStateUpdated.object

enrollmentStateUpdated.group

User Account Association Created

userAccountAssociationCreated.actor

userAccountAssociationCreated.object

Wiki Page Created

wikiPageCreated.actor

wikiPageCreated.object

wikiPageCreated.group

Wiki Page Updated

wikiPageUpdated.actor

wikiPageUpdated.object

wikiPageUpdated.group

Wiki Page Deleted

wikiPageDeleted.actor

wikiPageDeleted.object

wikiPageDeleted.group

Group Category Created

groupCategoryCreated.actor

groupCategoryCreated.object

groupCategoryCreated.group

Group Created

groupCreated.actor

groupCreated.object

Group Membership Created

groupMembershipCreated.actor

groupMembershipCreated.object.organization

Syllabus Updated

syllabusUpdated.actor

 

Forum Profile: indicates participation in discussion forums

 

Discussion Entry Created

discussionEntryCreated.actor

discussionEntryCreated.object

discussionEntryCreated.group

Discussion Topic Created

discussionTopicCreated.actor

discussionTopicCreated.object

discussionTopicCreated.group

 

Session Profile: indicates user logins and logouts

 

Logged In

loggedIn.actor

loggedIn.object

Logged Out

loggedOut.actor

 

Outcome Profile: indicates grade changes

 

Grade Changed

gradeChanged.object

gradeChanged.generated

gradeChanged.attempt

gradeChanged.group

 

Reading Profile: indicates when users access resources

 

Asset Accessed

assetAccessed.actor

assetAccessed.object

assetAccessed.group

 

Assessment Profile: indicates user interactions with creating and submitting assignments or quizzes

 

Assignment Created

assignmentCreated.actor

assignmentCreated.object

assignmentCreated.group

Assignment Updated

assignmentUpdated.actor

assignmentUpdated.object

assignmentUpdated.group

Submission Created

submissionCreated.actor

submissionCreated.object

submissionCreated.group

Submission Updated

submissionUpdated.actor

submissionUpdated.object

submissionUpdated.group

Quiz Submitted

quizSubmitted.actor

quizSubmitted.object

quizSubmitted.group

Attachments

    Outcomes