Live Events: Event Type by Format

Document created by Oxana Jurosevic Administrator on Oct 17, 2018Last modified by Oxana Jurosevic Administrator on Oct 23, 2019
Version 40Show Document
  • View in full screen mode

              Back to : Table of Contents

8/23/2019 ATTENTION:

 

Compressed Events
For users of Live Events, previous behavior of supporting all events has been deprecated. All events are being compressed to allow for smaller payloads. All data elements with null values will be omitted from events payloads.

 

Per API guidelines, this change provides a transition period for users to adjust custom applications. Existing functionality will be removed in the December 21 release and all events will be compressed by default. For an example of this compression behavior, please see Example: Compressed vs Non-Compressed Event

Event Payloads consist of two parts : metadata and body, identifiers in the body of earlier developed event types are global e.g asset_accessed context_id: 121070000000000565 and in the events released recently e.g discussion_entry_submitted identifiers are local  ( discussion_entry_id : 66) . Canvas customers databases undergo periodic data migrations, the migrations impact some of the data values such as global identifiers, Live Events is moving towards leveraging local IDs in the new event types as well as gradually updating existing events to provide local IDs  in the body. We recommend any downstream systems using Live Events to truncating global IDs to derive their objects local IDs. Any change to ID value in the existing events will be communicated in the community documentation in advance .  

 

 

 

This table describes which type of Event is supported by a specific Format. Note that any event that starts with “quizzes” describes an event that occurs in Instructure Quizzes.Next solution. All IDs provided in the messages emitted by Quizzes.Next are local IDs and will not exist in Canvas API or Canvas Data . Please inform Canvas Data and Live Events product management via your CSM if any events you are interested need to support Canvas specific IDs.

 

Event TypeIMS Caliper v1.1 FormatCanvas Format
account_notification_created
asset_accessed
asset_accessed ( LTI launch)
assignment_created
assignment_group_created
assignment_group_updated
assignment_updated
attachment_created
attachment_deleted
attachment_updated
content_migration_completed
course announcement ( discussion_topic_created)
course_completed (  final module requirement is completed)
course_progress (  one of the module req's is completed) 
course_created

 

course_section_created
course_section_updated
course_updated
discussion_entry_created
discussion_entry_submitted   
discussion_topic_created
discussion_topic_updated
enrollment_created
enrollment_updated
enrollment_state_created
enrollment_state_updated
grade_change
group_category_created
group_category_updated
group_created
group_membership_created
group_membership_updated
group_updated
logged_in
logged_out
module_created
module_item_created
module_item_updated
module_updated
learning_outcome_result_created  
learning_outcome_result_updated  
plagiarism_resubmit ( submission_* event )
quiz_export_complete
quiz_submitted
quizzes-lti.grade_changed
quizzes.item_created
quizzes.item_updated
quizzes.qti_import_completed
quizzes.quiz_clone_job_created
quizzes.quiz_clone_job_updated
quizzes.quiz_created
quizzes.quiz_graded
quizzes.quiz_session_graded
quizzes.quiz_session_submitted
quizzes.quiz_updated
quizzes_next_quiz_duplicated
submission_created
submission_updated
submission_comment_created   
submission_comment_updated  
syllabus_updated
user_account_association_created
user_created
user_updated
wiki_page_created
wiki_page_deleted
wiki_page_updated

 

Back to : Table of Contents

2 people found this helpful

Attachments

    Outcomes