search
Community

Basic

circle-exclamation

Welcome to Our New API Docs! This is the new home for all things API (previously at Canvas LMS REST API Documentationarrow-up-right).

hashtag
Basic

hashtag
assignment_created

Definition: The event is emitted anytime a new assignment is created by an end user or API request.

Trigger: Triggered when a new assignment is created in a course.

hashtag
Event Body Schema

Field
Description

data[0].group.extensions["com.instructure.canvas"].context_type

Canvas context type where the action took place e.g context_type = Course.

data[0].group.extensions["com.instructure.canvas"].entity_id

Canvas context ID

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"].lock_at

The lock date (assignment is locked after this date)

data[0].object.type

AssignableDigitalResource

hashtag
Payload Example:

{
  "sensor": "http://oxana.instructure.com/",
  "sendTime": "2019-11-16T02:08:59.579Z",
  "dataVersion": "http://purl.imsglobal.org/ctx/caliper/v1p1",
  "data": [
    {
      "@context": "http://purl.imsglobal.org/ctx/caliper/v1p1",
      "id": "urn:uuid:3f672715-6aa8-4293-b62a-3b3319ff5701",
      "type": "Event",
      "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": "VicYj3cu5BIFpoZhDVU4DZumnlBrWi1grgJEzADs.oxana.instructure.com",
            "root_account_uuid": "VicYj3cu5BIFpoZhDVU4DZumnlBrWi1grgJEzADs",
            "entity_id": "21070000000000001"
          }
        }
      },
      "action": "Created",
      "object": {
        "id": "urn:instructure:canvas:assignment:21070000000000371",
        "type": "AssignableDigitalResource",
        "name": "add_new_assignment_3",
        "description": "<p>test assignment</p>",
        "dateCreated": "2018-10-03T14:50:31.000Z",
        "extensions": {
          "com.instructure.canvas": {
            "lock_at": "2018-10-01T05:59:59.000Z",
            "entity_id": "21070000000000371"
          }
        },
        "dateToShow": "2018-09-24T06:00:00.000Z",
        "dateToSubmit": "2018-10-01T05:59:59.000Z",
        "maxScore": 100
      },
      "eventTime": "2019-11-01T19:11:11.323Z",
      "edApp": {
        "id": "http://oxana.instructure.com/",
        "type": "SoftwareApplication"
      },
      "group": {
        "id": "urn:instructure:canvas:course:21070000000000565",
        "type": "CourseOffering",
        "extensions": {
          "com.instructure.canvas": {
            "context_type": "Course",
            "entity_id": "21070000000000565"
          }
        }
      },
      "membership": {
        "id": "urn:instructure:canvas:course:21070000000000565:Instructor:21070000000000001",
        "type": "Membership",
        "member": {
          "id": "urn:instructure:canvas:user:21070000000000001",
          "type": "Person"
        },
        "organization": {
          "id": "urn:instructure:canvas:course:21070000000000565",
          "type": "CourseOffering"
        },
        "roles": [
          "Instructor"
        ]
      },
      "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/api/v1/courses/565/assignments",
          "version": "1.0.0"
        }
      }
    }
  ]
}

hashtag
assignment_override_created

Definition: The event is emitted anytime an assignment override is created by an end user or API request.

Trigger: Triggered when an assignment override is created.

hashtag
Event Body Schema

Field
Description

data[0].group.extensions["com.instructure.canvas"].context_type

Canvas context type where the action took place e.g context_type = Course.

data[0].group.extensions["com.instructure.canvas"].entity_id

Canvas context ID

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"].assignment_id

The Canvas id of the assignment linked to the override.

data[0].object.extensions["com.instructure.canvas"].all_day

The overridden all_day flag, or nil if not overridden.

data[0].object.extensions["com.instructure.canvas"].all_day_date

The overridden all_day_date, or nil if not overridden.

data[0].object.extensions["com.instructure.canvas"].lock_at

The overridden lock_at timestamp, or nil if not overridden.

data[0].object.extensions["com.instructure.canvas"].type

Override type - ADHOC (list of Students), CourseSection, or Group.

data[0].object.extensions["com.instructure.canvas"].course_section_id

(if type='CourseSection') Canvas section id that this override applies to.

data[0].object.extensions["com.instructure.canvas"].group_id

(if type='Group') Canvas group id that this override applies to.

data[0].object.extensions["com.instructure.canvas"].workflow_state

Workflow state of the override. (active, deleted)

data[0].object.type

Entity

hashtag
Payload Example:

hashtag
assignment_override_updated

Definition: The event is emitted anytime an assignment override is updated by an end user or API request. Only changes to the fields included in the body of the event payload will emit the updated event.

Trigger: Triggered when an assignment override has been modified.

hashtag
Event Body Schema

Field
Description

data[0].group.extensions["com.instructure.canvas"].context_type

Canvas context type where the action took place e.g context_type = Course.

data[0].group.extensions["com.instructure.canvas"].entity_id

Canvas context ID

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"].assignment_id

The Canvas id of the assignment linked to the override.

data[0].object.extensions["com.instructure.canvas"].all_day

The overridden all_day flag, or nil if not overridden.

data[0].object.extensions["com.instructure.canvas"].all_day_date

The overridden all_day_date, or nil if not overridden.

data[0].object.extensions["com.instructure.canvas"].lock_at

The overridden lock_at timestamp, or nil if not overridden.

data[0].object.extensions["com.instructure.canvas"].type

Override type - ADHOC (list of Students), CourseSection, or Group.

data[0].object.extensions["com.instructure.canvas"].course_section_id

(if type='CourseSection') Canvas section id that this override applies to.

data[0].object.extensions["com.instructure.canvas"].group_id

(if type='Group') Canvas group id that this override applies to.

data[0].object.extensions["com.instructure.canvas"].workflow_state

Workflow state of the override. (active, deleted)

data[0].object.type

Entity

hashtag
Payload Example:

hashtag
assignment_updated

Definition: The event is emitted anytime an assignment is updated by an end user or API request. Only changes to the fields included in the body of the event payload will emit the updated event.

Trigger: Triggered when an assignment has been modified.

hashtag
Event Body Schema

Field
Description

data[0].group.extensions["com.instructure.canvas"].context_type

Canvas context type where the action took place e.g context_type = Course.

data[0].group.extensions["com.instructure.canvas"].entity_id

Canvas context ID

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"].lock_at

The lock date (assignment is locked after this date)

data[0].object.extensions["com.instructure.canvas"].workflow_state

1. Workflow state of the assignment when used in the assignment context (deleted, duplicating, fail_to_import, failed_to_duplicate, failed_to_migrate, importing, published, unpublished) - 2. Workflow state of the enrollment when used in the enrollment context (active, completed, creation_pending, deleted, inactive, invited)

data[0].object.type

AssignableDigitalResource

hashtag
Payload Example:

hashtag
attachment_created

Definition: The event is emitted anytime a new file is uploaded by an end user or API request.

Trigger: Triggered anytime a file is uploaded into a course or user file directory.

hashtag
Event Body Schema

Field
Description

data[0].group.extensions["com.instructure.canvas"].context_type

Canvas context type where the action took place e.g context_type = Course.

data[0].group.extensions["com.instructure.canvas"].entity_id

Canvas context ID

data[0].object.extensions["com.instructure.canvas"].context_id

The Canvas id of the current context

data[0].object.extensions["com.instructure.canvas"].context_type

The type of context where the event happened

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"].filename

The file name of the attachment. NOTE: This field will be truncated to only include the first 8192 characters.

data[0].object.extensions["com.instructure.canvas"].folder_id

The id of the folder where the attachment was saved

data[0].object.type

Document

hashtag
Payload Example:

hashtag
attachment_deleted

Definition: The event is emitted anytime a file is removed by an end user or API request.

Trigger: Triggered anytime a file is deleted from a course or user file directory.

hashtag
Event Body Schema

Field
Description

data[0].group.extensions["com.instructure.canvas"].context_type

Canvas context type where the action took place e.g context_type = Course.

data[0].group.extensions["com.instructure.canvas"].entity_id

Canvas context ID

data[0].object.extensions["com.instructure.canvas"].context_id

The Canvas id of the current context

data[0].object.extensions["com.instructure.canvas"].context_type

The type of context where the event happened

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"].filename

The file name of the attachment. NOTE: This field will be truncated to only include the first 8192 characters.

data[0].object.extensions["com.instructure.canvas"].folder_id

The id of the folder where the attachment was saved

data[0].object.type

Document

hashtag
Payload Example:

hashtag
attachment_updated

Definition: The event is emitted anytime a file is updated by an end user or API request. Only changes to the fields included in the body of the event payload will emit the updated event.

Trigger: Triggered anytime a file is updated in a course or user file directory.

hashtag
Event Body Schema

Field
Description

data[0].group.extensions["com.instructure.canvas"].context_type

Canvas context type where the action took place e.g context_type = Course.

data[0].group.extensions["com.instructure.canvas"].entity_id

Canvas context ID

data[0].object.extensions["com.instructure.canvas"].context_id

The Canvas id of the current context

data[0].object.extensions["com.instructure.canvas"].context_type

The type of context where the event happened

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"].filename

The file name of the attachment. NOTE: This field will be truncated to only include the first 8192 characters.

data[0].object.extensions["com.instructure.canvas"].folder_id

The id of the folder where the attachment was saved

data[0].object.type

Document

hashtag
Payload Example:

hashtag
course_created

Definition: The event is emitted anytime a new course is created by an end user or API request.

Trigger: Triggered when a new course is created (or copied).

hashtag
Event Body Schema

Field
Description

data[0].object.extensions["com.instructure.canvas"].entity_id

Canvas global ID of the object affected by the event

data[0].object.type

CourseOffering

hashtag
Payload Example:

hashtag
course_updated

Definition: The event is emitted anytime a course is updated by an end user or API request. Examples of updates include publishing a course, updating a course name, or changing a course's configuration.

Trigger: Triggered when a course is updated.

hashtag
Event Body Schema

Field
Description

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"].workflow_state

The workflow state of the the course. Can be one of created or claimed (unpublished course), available (published course), completed, or deleted.

data[0].object.type

CourseOffering

hashtag
Payload Example:

hashtag
enrollment_created

Definition: The event is emitted anytime a new enrollment is added to a course by an end user or API request.

Trigger: Triggered when a new course enrollment is created.

hashtag
Event Body Schema

Field
Description

data[0].group.extensions["com.instructure.canvas"].context_type

Canvas context type where the action took place e.g context_type = Course.

data[0].group.extensions["com.instructure.canvas"].entity_id

Canvas context ID

data[0].object.extensions["com.instructure.canvas"].course_id

The Canvas id of the course for this enrollment

data[0].object.extensions["com.instructure.canvas"].course_section_id

The id of the section of the course for the new enrollment

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"].limit_privileges_to_course_section

Whether students can only talk to students within their course section

data[0].object.extensions["com.instructure.canvas"].type

The type of enrollment; e.g. StudentEnrollment, TeacherEnrollment, ObserverEnrollment, etc.

data[0].object.extensions["com.instructure.canvas"].user_id

The Canvas id of the currently logged in user

data[0].object.extensions["com.instructure.canvas"].user_name

The user first and last name

data[0].object.extensions["com.instructure.canvas"].workflow_state

1. Workflow state of the assignment when used in the assignment context (deleted, duplicating, fail_to_import, failed_to_duplicate, failed_to_migrate, importing, published, unpublished) - 2. Workflow state of the enrollment when used in the enrollment context (active, completed, creation_pending, deleted, inactive, invited)

data[0].object.type

Entity

hashtag
Payload Example:

hashtag
enrollment_state_created

Definition: The event is emitted anytime a new enrollment record is added to a course.

Trigger: Triggered when a new course enrollment is created with a new workflow_state.

hashtag
Event Body Schema

Field
Description

data[0].group.extensions["com.instructure.canvas"].context_type

Canvas context type where the action took place e.g context_type = Course.

data[0].group.extensions["com.instructure.canvas"].entity_id

Canvas context ID

data[0].object.extensions["com.instructure.canvas"].access_is_current

Indicates if the enrollment_state is up to date

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"].restricted_access

Indicates whether enrollment access is restricted, set to 'TRUE' if enrollment state is restricted

data[0].object.extensions["com.instructure.canvas"].state_is_current

Indicates if this enrollment_state is up to date

data[0].object.extensions["com.instructure.canvas"].state

The state of the enrollment

data[0].object.extensions["com.instructure.canvas"].state_valid_until

The time at which this enrollment is no longer valid

data[0].object.type

Entity

hashtag
Payload Example:

hashtag
enrollment_state_updated

Definition: The event is emitted anytime an enrollment record workflow state changes.

Trigger: Triggered when a course enrollment workflow_state changes.

hashtag
Event Body Schema

Field
Description

data[0].group.extensions["com.instructure.canvas"].context_type

Canvas context type where the action took place e.g context_type = Course.

data[0].group.extensions["com.instructure.canvas"].entity_id

Canvas context ID

data[0].object.extensions["com.instructure.canvas"].access_is_current

Indicates if the enrollment_state is up to date

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"].restricted_access

Indicates whether enrollment access is restricted, set to 'TRUE' if enrollment state is restricted

data[0].object.extensions["com.instructure.canvas"].state_is_current

Indicates if this enrollment_state is up to date

data[0].object.extensions["com.instructure.canvas"].state

The state of the enrollment

data[0].object.extensions["com.instructure.canvas"].state_valid_until

The time at which this enrollment is no longer valid

data[0].object.type

Entity

hashtag
Payload Example:

hashtag
enrollment_updated

Definition: The event is emitted anytime an enrollment record is updated by an end user or API request. Only changes to the fields included in the body of the event payload will emit the updated event.

Trigger: Triggered when a course enrollment is modified.

hashtag
Event Body Schema

Field
Description

data[0].group.extensions["com.instructure.canvas"].context_type

Canvas context type where the action took place e.g context_type = Course.

data[0].group.extensions["com.instructure.canvas"].entity_id

Canvas context ID

data[0].object.extensions["com.instructure.canvas"].course_id

The Canvas id of the course for this enrollment

data[0].object.extensions["com.instructure.canvas"].course_section_id

The id of the section of the course for the new enrollment

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"].limit_privileges_to_course_section

Whether students can only talk to students within their course section

data[0].object.extensions["com.instructure.canvas"].type

The type of enrollment; e.g. StudentEnrollment, TeacherEnrollment, ObserverEnrollment, etc.

data[0].object.extensions["com.instructure.canvas"].user_id

The Canvas id of the currently logged in user

data[0].object.extensions["com.instructure.canvas"].user_name

The user first and last name

data[0].object.extensions["com.instructure.canvas"].workflow_state

1. Workflow state of the assignment when used in the assignment context (deleted, duplicating, fail_to_import, failed_to_duplicate, failed_to_migrate, importing, published, unpublished) - 2. Workflow state of the enrollment when used in the enrollment context (active, completed, creation_pending, deleted, inactive, invited)

data[0].object.type

Entity

hashtag
Payload Example:

hashtag
group_category_created

Definition: The event is emitted anytime a new group category is added to a course group by an end user or API request.

Trigger: Triggered when a new group category is created.

hashtag
Event Body Schema

Field
Description

data[0].group.extensions["com.instructure.canvas"].context_type

Canvas context type where the action took place e.g context_type = Course.

data[0].group.extensions["com.instructure.canvas"].entity_id

Canvas context ID

data[0].object.extensions["com.instructure.canvas"].entity_id

Canvas global ID of the object affected by the event

data[0].object.type

Entity

hashtag
Payload Example:

hashtag
group_created

Definition: The event is emitted anytime a new group is added to a course by an end user or API request.

Trigger: Triggered when a new group is created.

hashtag
Event Body Schema

Field
Description

data[0].group.extensions["com.instructure.canvas"].context_type

Canvas context type where the action took place e.g context_type = Course.

data[0].group.extensions["com.instructure.canvas"].entity_id

Canvas context ID

data[0].object.type

Group

hashtag
Payload Example:

hashtag
group_membership_created

Definition: The event is emitted anytime a new member is added to a course group by an end user or API request.

Trigger: Triggered when a new user is added to a group.

hashtag
Event Body Schema

Field
Description

data[0].object.extensions["com.instructure.canvas"].entity_id

Canvas global ID of the object affected by the event

data[0].object.type

Membership

hashtag
Payload Example:

hashtag
submission_created

Definition: The event is emitted anytime an end user or API request submits an assignment.

Trigger: Triggered when a submission gets updated and has not yet been submitted.

hashtag
Event Body Schema

Field
Description

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"].submission_type

The types of submission (basic_lti_launch, discussion_topic, media_recording, online_quiz, online_text_entry, online_upload, online_url)

data[0].object.extensions["com.instructure.canvas"].url

The URL of the request that triggered the event. Only present in user-generated events

data[0].object.type

Attempt

hashtag
Payload Example:

hashtag
submission_updated

Definition: The event is emitted anytime an end user or API request re-submits an assignment.

Trigger: Triggered when a submission gets updated and has previously been submitted.

hashtag
Event Body Schema

Field
Description

data[0].group.extensions["com.instructure.canvas"].context_type

Canvas context type where the action took place e.g context_type = Course.

data[0].group.extensions["com.instructure.canvas"].entity_id

Canvas context ID

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"].submission_type

The types of submission (basic_lti_launch, discussion_topic, media_recording, online_quiz, online_text_entry, online_upload, online_url)

data[0].object.type

Attempt

hashtag
Payload Example:

hashtag
syllabus_updated

Definition: The event is emitted anytime a syllabus is changed in a course by an end user or API request. Only changes to the fields included in the body of the event payload will emit the updated event.

Trigger: Triggered when a course syllabus gets updated.

hashtag
Event Body Schema

Field
Description

data[0].object.type

Document

hashtag
Payload Example:

hashtag
user_account_association_created

Definition: The event is emitted anytime a user is created in an account.

Trigger: Triggered when a user is added to an account.

hashtag
Event Body Schema

Field
Description

data[0].object.extensions["com.instructure.canvas"].is_admin

Indicates whether a user has an administrator role

data[0].object.extensions["com.instructure.canvas"].user_id

The Canvas id of the currently logged in user

data[0].object.type

Entity

hashtag
Payload Example:

hashtag
wiki_page_created

Definition: The event is emitted anytime a new wiki page is created by an end user or API request.

Trigger: Triggered when a new wiki page is created.

hashtag
Event Body Schema

Field
Description

data[0].group.extensions["com.instructure.canvas"].context_type

Canvas context type where the action took place e.g context_type = Course.

data[0].group.extensions["com.instructure.canvas"].entity_id

Canvas context ID

data[0].object.extensions["com.instructure.canvas"].body

The body of the new page. NOTE: This field will be truncated to only include the first 8192 characters.

data[0].object.extensions["com.instructure.canvas"].entity_id

Canvas global ID of the object affected by the event

data[0].object.type

Page

hashtag
Payload Example:

hashtag
wiki_page_deleted

Definition: The event is emitted anytime a wiki page is deleted by an end user or API request.

Trigger: Triggered when a wiki page is deleted.

hashtag
Event Body Schema

Field
Description

data[0].group.extensions["com.instructure.canvas"].context_type

Canvas context type where the action took place e.g context_type = Course.

data[0].group.extensions["com.instructure.canvas"].entity_id

Canvas context ID

data[0].object.extensions["com.instructure.canvas"].body

The body of the new page. NOTE: This field will be truncated to only include the first 8192 characters.

data[0].object.extensions["com.instructure.canvas"].entity_id

Canvas global ID of the object affected by the event

data[0].object.type

Page

hashtag
Payload Example:

hashtag
wiki_page_updated

Definition: The event is emitted anytime a wiki page is altered by an end user or API request.

Trigger: Triggered when title or body of wiki page is altered.

hashtag
Event Body Schema

Field
Description

data[0].group.extensions["com.instructure.canvas"].context_type

Canvas context type where the action took place e.g context_type = Course.

data[0].group.extensions["com.instructure.canvas"].entity_id

Canvas context ID

data[0].object.extensions["com.instructure.canvas"].body

The body of the new page. NOTE: This field will be truncated to only include the first 8192 characters.

data[0].object.extensions["com.instructure.canvas"].entity_id

Canvas global ID of the object affected by the event

data[0].object.type

Page

hashtag
Payload Example:

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

PreviousAssessmentNextForum

Last updated

Was this helpful?