Navigation Events
Welcome to Our New API Docs! This is the new home for all things API (previously at Canvas LMS REST API Documentation).
Navigation Events
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.
Trigger: Triggered when a variety of assets are viewed.
Event Body Schema
data[0].object.extensions["com.instructure.canvas"].asset_name
indicates Canvas object name being accessed in the NavigationEvent. For an example it could be a title of a course, page, module, assignment, LTI, attachment etc
data[0].object.extensions["com.instructure.canvas"].asset_subtype
indicates Canvas object sub-type being accessed in the NavigationEvent
data[0].object.extensions["com.instructure.canvas"].asset_type
indicates Canvas object type being accessed in the NavigationEvent
data[0].object.extensions["com.instructure.canvas"].context_account_id
The account id of the current context. This is the actual account the context is attached to could be account, sub-account, course
data[0].object.extensions["com.instructure.canvas"].entity_id
Canvas global ID of the object affected by the event
data[0].object.extensions["com.instructure.canvas"].http_method
HTTP method/verb (GET, PUT, POST etc.) that the request was sent with. Only present in user-generated events
data[0].object.type
Entity
Description: type=account, subtype=outcomes
Payload Example:
{
"sensor": "http://oxana.instructure.com/",
"sendTime": "2019-11-16T02:08:46.287Z",
"dataVersion": "http://purl.imsglobal.org/ctx/caliper/v1p1",
"data": [
{
"@context": "http://purl.imsglobal.org/ctx/caliper/v1p1",
"id": "urn:uuid:02729bac-c975-4e22-b312-6a7f1d8be173",
"type": "NavigationEvent",
"actor": {
"id": "urn:instructure:canvas:user:21070000000000001",
"type": "Person",
"extensions": {
"com.instructure.canvas": {
"user_login": "[email protected]",
"user_sis_id": "456-T45",
"root_account_id": "21070000000000001",
"root_account_lti_guid": "7db438071375c02373713c12c73869ff2f470b68.oxana.instructure.com",
"root_account_uuid": "VicYj3cu5BIFpoZhDVU4DZumnlBrWi1grgJEzADs",
"entity_id": "21070000000000001"
}
}
},
"action": "NavigatedTo",
"object": {
"id": "urn:instructure:canvas:account:21070000000000001",
"type": "Entity",
"name": "outcomes",
"extensions": {
"com.instructure.canvas": {
"asset_name": "Canvas County School District",
"asset_type": "account",
"asset_subtype": "outcomes",
"entity_id": "21070000000000001",
"context_account_id": "210700000000000001",
"http_method": "GET"
}
}
},
"eventTime": "2019-11-04T14:46:31.249Z",
"referrer": "https://oxana.instructure.com/accounts/1/outcomes",
"edApp": {
"id": "http://oxana.instructure.com/",
"type": "SoftwareApplication"
},
"session": {
"id": "urn:instructure:canvas:session:ef686f8ed684abf78cbfa1f6a58112b5",
"type": "Session"
},
"extensions": {
"com.instructure.canvas": {
"hostname": "oxana.instructure.com",
"request_id": "1dd9dc6f-2fb0-4c19-a6c5-7ee1bf3ed295",
"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",
"request_url": "https://oxana.instructure.com/accounts/1/outcomes",
"version": "1.0.0"
}
}
}
]
}Description: type=assignment
Payload Example:
Description: type=attachment
Payload Example:
Description: type=calendar_event
Payload Example:
Description: type=collaboration
Payload Example:
Description: type=content_tag
Payload Example:
Description: type=context_external_tool (this type is used to identify all LTI versions but LTI 2.0 launches)
Payload Example:
Description: type=course, subtype=announcements
Payload Example:
Description: type=course, subtype=assignments
Payload Example:
Description: type=course, subtype=calendar_feed
Payload Example:
Description: type=course, subtype=collaborations
Payload Example:
Description: type=course, subtype=conferences
Payload Example:
Description: type=course, subtype=files
Payload Example:
Description: type=course, subtype=grades
Payload Example:
Description: type=course, subtype=home
Payload Example:
Description: type=course, subtype=modules
Payload Example:
Description: type=course, subtype=outcomes
Payload Example:
Description: type=course, subtype=pages
Payload Example:
Description: type=course, subtype=quizzes
Payload Example:
Description: type=course, subtype=roster
Payload Example:
Description: type=course, subtype=speed_grader
Payload Example:
Description: type=course, subtype=syllabus
Payload Example:
Description: type=course, subtype=topics
Payload Example:
Description: type=discussion_topic
Payload Example:
Description: type=enrollment
Payload Example:
Description: type=group, subtype=announcements
Payload Example:
Description: type=group, subtype=calendar_feed
Payload Example:
Description: type=group, subtype=collaborations
Payload Example:
Description: type=group, subtype=conferences
Payload Example:
Description: type=group, subtype=files
Payload Example:
Description: type=group, subtype=pages
Payload Example:
Description: type=group, subtype=roster
Payload Example:
Description: type=group, subtype=topics
Payload Example:
Description: type=learning_outcome
Payload Example:
Description: type=lti/tool_proxy (this type is used to identify LTI 2.0 launches)
Payload Example:
Description: type=quizzes:quiz
Payload Example:
Description: type=user, subtype=calendar_feed
Payload Example:
Description: type=user, subtype=files
Payload Example:
Description: type=web_conference
Payload Example:
Description: type=wiki_page
Payload Example:
This documentation is generated directly from the Canvas LMS source code, available on Github.
Last updated
Was this helpful?