Asset

circle-exclamation

Asset

asset_accessed

Definition: asset_accessed events are triggered for viewing various objects in Canvas. Viewing a quiz, a wiki page, the list of quizzes, etc, all generate asset_access events. The item being accessed is identified by asset_type, asset_id, and asset_subtype. If asset_subtype is set, then it refers to a list of items in the asset. For example, if asset_type is course, and asset_subtype is quizzes, then this is referring to viewing the list of quizzes in the course.

If asset_subtype is not set, then the access is on the asset described by asset_type and asset_id.

Trigger: Triggered when a variety of assets are viewed.

Description: type=group, subtype=conferences

Payload Example:

{
  "metadata": {
    "root_account_uuid": "VicYj3cu5BIFpoZhDVU4DZumnlBrWi1grgJEzADs",
    "root_account_id": "21070000000000001",
    "root_account_lti_guid": "7db438071375c02373713c12c73869ff2f470b68.oxana.instructure.com",
    "user_login": "[email protected]",
    "user_account_id": "21070000000000001",
    "user_sis_id": "456-T45",
    "user_id": "21070000000000001",
    "time_zone": "America/New_York",
    "context_type": "Group",
    "context_id": "21070000000000144",
    "context_sis_source_id": "2017.100.101.101-1",
    "context_account_id": "21070000000000079",
    "context_role": "GroupMembership",
    "request_id": "1dd9dc6f-2fb0-4c19-a6c5-7ee1bf3ed295",
    "session_id": "ef686f8ed684abf78cbfa1f6a58112b5",
    "hostname": "oxana.instructure.com",
    "http_method": "GET",
    "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/73.0.3683.103 Safari/537.36",
    "client_ip": "93.184.216.34",
    "url": "https://oxana.instructure.com/groups/144/conferences",
    "referrer": "https://oxana.instructure.com/groups/144/conferences",
    "producer": "canvas",
    "event_name": "asset_accessed",
    "event_time": "2019-11-01T00:09:07.150Z"
  },
  "body": {
    "asset_name": "MATH 101 Group 1",
    "asset_type": "group",
    "asset_id": "21070000000000144",
    "asset_subtype": "conferences",
    "category": "conferences",
    "role": "GroupMembership",
    "level": null
  }
}

Description: type=course, subtype=assignments

Payload Example:

Description: type=enrollment

Payload Example:

Description: type=course, subtype=files

Payload Example:

Description: type=user, subtype=calendar_feed

Payload Example:

Description: type=collaboration

Payload Example:

Description: type=user, subtype=files

Payload Example:

Description: type=account, subtype=outcomes

Payload Example:

Description: type=course, subtype=grades

Payload Example:

Description: type=course, subtype=conferences

Payload Example:

Description: type=course, subtype=syllabus

Payload Example:

Description: type=course, subtype=pages

Payload Example:

Description: type=quizzes:quiz

Payload Example:

Description: type=context_external_tool (this type is used to identify all LTI versions except LTI 2.0 launches)

Payload Example:

Description: type=course, subtype=modules

Payload Example:

Description: type=lti/tool_proxy (this type is used to identify LTI 2.0 launches)

Payload Example:

Description: type=course, subtype=roster

Payload Example:

Description: type=course, subtype=calendar_feed

Payload Example:

Description: type=assignment

Payload Example:

Description: type=course, subtype=home

Payload Example:

Description: type=group, subtype=calendar_feed

Payload Example:

Description: type=group, subtype=files

Payload Example:

Description: type=group, subtype=pages

Payload Example:

Description: type=calendar_event

Payload Example:

Description: type=course, subtype=outcomes

Payload Example:

Description: type=group, subtype=announcements

Payload Example:

Description: type=course, subtype=speed_grader

Payload Example:

Description: type=group, subtype=topics

Payload Example:

Description: type=course, subtype=announcements

Payload Example:

Description: type=course, subtype=topics

Payload Example:

Description: type=web_conference

Payload Example:

Description: type=content_tag

Payload Example:

Description: type=learning_outcome

Payload Example:

Description: type=wiki_page

Payload Example:

Description: type=discussion_topic

Payload Example:

Description: type=attachment

Payload Example:

Description: type=group, subtype=roster

Payload Example:

Description: type=course, subtype=collaborations

Payload Example:

Description: type=course, subtype=quizzes

Payload Example:

Description: type=group, subtype=collaborations

Payload Example:

Event Body Schema

Field
Description

asset_id

The Canvas id of the asset.

asset_name

The title of a course, page, module, assignment, LTI, attachment etc.

asset_subtype

The sub type of asset being accessed.

asset_type

The type of asset being accessed.

category

A categorized list of values based on the asset or asset subtype accessed. (announcements, assignments, calendar, collaborations, conferences, external_tools, external_urls, files, grades, home, modules, outcomes, pages, quizzes, roster, syllabus, topics, wiki)

display_name

The display name of the attachment, possibly truncated.

domain

The domain of the LTI tool, when subtype is context_external_tool.

filename

The file name of the attachment, possibly truncated.

level

Usually null, can be used to indicate a deeper level of access. Can be "submit" for assignments. Can be "participate" for collaboration, calendar, discussion_topic (user posts to topic), quizzes:quiz, web_conference, or wiki_page (page created or edited).

role

The role of the user accessing the asset. (AccountUser, DesignerEnrollment, GroupMembership, ObserverEnrollment, StudentEnrollment, StudentViewEnrollment, TaEnrollment, TeacherEnrollment, User)

url

The URL of the LTI tool, when subtype is context_external_tool.

Note: Timestamps will be in ISO8601 format, including an offset. Be sure to take that into account when parsing, since it’s unspecified which offset timestamps will use, and the offset may even change between different timestamps within a single event.


This documentation is generated directly from the Canvas LMS source code, available on Githubarrow-up-right.

Last updated

Was this helpful?