Basic

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.

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

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": "oxana@example.com",
            "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"
        }
      }
    }
  ]
}

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.

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

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": "oxana@example.com",
            "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_override:21070000000000371",
        "type": "Entity",
        "extensions": {
          "com.instructure.canvas": {
            "lock_at": "2018-10-01T05:59:59.000Z",
            "entity_id": "21070000000000371",
            "assignment_id": "1035",
            "all_day": false,
            "all_day_date": "2018-10-01T05:59:59.000Z",
            "type": "ADHOC",
            "workflow_state": "active"
          }
        },
        "dateToShow": "2018-09-24T06:00:00.000Z",
        "dateToSubmit": "2018-10-01T05:59:59.000Z"
      },
      "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"
        }
      }
    }
  ]
}

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.

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

Payload Example:

{
  "sensor": "http://oxana.instructure.com/",
  "sendTime": "2019-11-16T02:09:00.554Z",
  "dataVersion": "http://purl.imsglobal.org/ctx/caliper/v1p1",
  "data": [
    {
      "@context": "http://purl.imsglobal.org/ctx/caliper/v1p1",
      "id": "urn:uuid:0a2a8c4d-0ebc-4200-ab6f-095b3b16852d",
      "type": "Event",
      "actor": {
        "id": "urn:instructure:canvas:user:21070000000000001",
        "type": "Person",
        "extensions": {
          "com.instructure.canvas": {
            "user_login": "oxana@example.com",
            "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": "Modified",
      "object": {
        "id": "urn:instructure:canvas:assignment_override:21070000000000371",
        "type": "Entity",
        "extensions": {
          "com.instructure.canvas": {
            "lock_at": "2018-10-01T05:59:59.000Z",
            "entity_id": "21070000000000371",
            "assignment_id": "1035",
            "all_day": false,
            "all_day_date": "2018-10-01T05:59:59.000Z",
            "type": "ADHOC",
            "workflow_state": "active"
          }
        },
        "dateToShow": "2018-09-24T06:00:00.000Z",
        "dateToSubmit": "2018-10-01T05:59:59.000Z"
      },
      "eventTime": "2019-11-01T19:11:14.005Z",
      "edApp": {
        "id": "http://oxana.instructure.com/",
        "type": "SoftwareApplication"
      },
      "group": {
        "id": "urn:instructure:canvas:course:21070000001279362",
        "type": "CourseOffering",
        "extensions": {
          "com.instructure.canvas": {
            "context_type": "Course",
            "entity_id": "21070000001279362"
          }
        }
      },
      "membership": {
        "id": "urn:instructure:canvas:course:21070000001279362:Instructor:21070000000000001",
        "type": "Membership",
        "member": {
          "id": "urn:instructure:canvas:user:21070000000000001",
          "type": "Person"
        },
        "organization": {
          "id": "urn:instructure:canvas:course:21070000001279362",
          "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/1279362/assignments/2030605",
          "version": "1.0.0"
        }
      }
    }
  ]
}

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.

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

Payload Example:

{
  "sensor": "http://oxana.instructure.com/",
  "sendTime": "2019-11-16T02:09:00.554Z",
  "dataVersion": "http://purl.imsglobal.org/ctx/caliper/v1p1",
  "data": [
    {
      "@context": "http://purl.imsglobal.org/ctx/caliper/v1p1",
      "id": "urn:uuid:0a2a8c4d-0ebc-4200-ab6f-095b3b16852d",
      "type": "Event",
      "actor": {
        "id": "urn:instructure:canvas:user:21070000000000001",
        "type": "Person",
        "extensions": {
          "com.instructure.canvas": {
            "user_login": "oxana@example.com",
            "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": "Modified",
      "object": {
        "id": "urn:instructure:canvas:assignment:21070000002030605",
        "type": "AssignableDigitalResource",
        "name": "A New Assignment For Today",
        "description": "<h3>Assignment Description<h3/> This is your tasks, students:...",
        "dateModified": "2019-11-05T13:38:00.218Z",
        "extensions": {
          "com.instructure.canvas": {
            "lock_at": "2019-11-05T13:38:00.218Z",
            "workflow_state": "published",
            "entity_id": "21070000002030605"
          }
        },
        "dateToShow": "2019-11-05T13:38:00.218Z",
        "dateToSubmit": "2019-11-05T13:38:00.218Z",
        "maxScore": 100
      },
      "eventTime": "2019-11-01T19:11:14.005Z",
      "edApp": {
        "id": "http://oxana.instructure.com/",
        "type": "SoftwareApplication"
      },
      "group": {
        "id": "urn:instructure:canvas:course:21070000001279362",
        "type": "CourseOffering",
        "extensions": {
          "com.instructure.canvas": {
            "context_type": "Course",
            "entity_id": "21070000001279362"
          }
        }
      },
      "membership": {
        "id": "urn:instructure:canvas:course:21070000001279362:Instructor:21070000000000001",
        "type": "Membership",
        "member": {
          "id": "urn:instructure:canvas:user:21070000000000001",
          "type": "Person"
        },
        "organization": {
          "id": "urn:instructure:canvas:course:21070000001279362",
          "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/1279362/assignments/2030605",
          "version": "1.0.0"
        }
      }
    }
  ]
}

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.

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

Payload Example:

{
  "sensor": "http://oxana.instructure.com/",
  "sendTime": "2019-11-16T02:09:00.877Z",
  "dataVersion": "http://purl.imsglobal.org/ctx/caliper/v1p1",
  "data": [
    {
      "@context": "http://purl.imsglobal.org/ctx/caliper/v1p1",
      "id": "urn:uuid:fd1fb7f0-405b-4487-a47d-3d5c0161061d",
      "type": "Event",
      "actor": {
        "id": "urn:instructure:canvas:user:210700001234567",
        "type": "Person",
        "extensions": {
          "com.instructure.canvas": {
            "root_account_id": "21070000000000001",
            "root_account_lti_guid": "VicYj3cu5BIFpoZhDVU4DZumnlBrWi1grgJEzADs.oxana.instructure.com",
            "root_account_uuid": "VicYj3cu5BIFpoZhDVU4DZumnlBrWi1grgJEzADs",
            "entity_id": "210700001234567"
          }
        }
      },
      "action": "Created",
      "object": {
        "id": "urn:instructure:canvas:attachment:21070000000000632",
        "type": "Document",
        "name": "enrollments (1).csv",
        "dateCreated": "2018-10-09T20:44:45.000Z",
        "extensions": {
          "com.instructure.canvas": {
            "context_id": "21070000000002329",
            "context_type": "Course",
            "filename": "enrollments+%281%29.csv",
            "folder_id": "21070000000001359",
            "entity_id": "21070000000000632"
          }
        },
        "mediaType": "text/csv"
      },
      "eventTime": "2019-11-01T19:11:00.830Z",
      "edApp": {
        "id": "http://oxana.instructure.com/",
        "type": "SoftwareApplication"
      },
      "group": {
        "id": "urn:instructure:canvas:course:21070000000002329",
        "type": "CourseOffering",
        "extensions": {
          "com.instructure.canvas": {
            "context_type": "Course",
            "entity_id": "21070000000002329"
          }
        }
      },
      "membership": {
        "id": "urn:instructure:canvas:course:21070000000002329:user:210700001234567",
        "type": "Membership",
        "member": {
          "id": "urn:instructure:canvas:user:210700001234567",
          "type": "Person"
        },
        "organization": {
          "id": "urn:instructure:canvas:course:21070000000002329",
          "type": "CourseOffering"
        }
      },
      "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/files/capture",
          "version": "1.0.0"
        }
      }
    }
  ]
}

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.

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

Payload Example:

{
  "sensor": "http://oxana.instructure.com/",
  "sendTime": "2019-11-16T02:09:01.199Z",
  "dataVersion": "http://purl.imsglobal.org/ctx/caliper/v1p1",
  "data": [
    {
      "@context": "http://purl.imsglobal.org/ctx/caliper/v1p1",
      "id": "urn:uuid:00ea719b-38ea-4beb-934c-758ffa2cf1ea",
      "type": "Event",
      "actor": {
        "id": "urn:instructure:canvas:user:21070000000123456",
        "type": "Person",
        "extensions": {
          "com.instructure.canvas": {
            "user_login": "oxana@example.com",
            "user_sis_id": "456-T45",
            "root_account_id": "21070000000000001",
            "root_account_lti_guid": "VicYj3cu5BIFpoZhDVU4DZumnlBrWi1grgJEzADs.oxana.instructure.com",
            "root_account_uuid": "VicYj3cu5BIFpoZhDVU4DZumnlBrWi1grgJEzADs",
            "entity_id": "21070000000123456"
          }
        }
      },
      "action": "Deleted",
      "object": {
        "id": "urn:instructure:canvas:attachment:21070000000000606",
        "type": "Document",
        "name": "enrollments.csv",
        "dateModified": "2018-10-11T20:32:48.000Z",
        "extensions": {
          "com.instructure.canvas": {
            "context_id": "21070000000000565",
            "context_type": "Course",
            "filename": "enrollments.csv",
            "folder_id": "21070000000001344",
            "entity_id": "21070000000000606"
          }
        },
        "mediaType": "text/csv"
      },
      "eventTime": "2019-11-01T04:00:46.918Z",
      "referrer": "https://oxana.instructure.com/courses/565/files",
      "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:user:21070000000123456",
        "type": "Membership",
        "member": {
          "id": "urn:instructure:canvas:user:21070000000123456",
          "type": "Person"
        },
        "organization": {
          "id": "urn:instructure:canvas:course:21070000000000565",
          "type": "CourseOffering"
        }
      },
      "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/files/606",
          "version": "1.0.0"
        }
      }
    }
  ]
}

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.

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

Payload Example:

{
  "sensor": "http://oxana.instructure.com/",
  "sendTime": "2019-11-16T02:09:01.502Z",
  "dataVersion": "http://purl.imsglobal.org/ctx/caliper/v1p1",
  "data": [
    {
      "@context": "http://purl.imsglobal.org/ctx/caliper/v1p1",
      "id": "urn:uuid:0d4f85b5-f541-4c14-a405-d6a01e578d32",
      "type": "Event",
      "actor": {
        "id": "urn:instructure:canvas:user:21070000000123456",
        "type": "Person",
        "extensions": {
          "com.instructure.canvas": {
            "user_login": "oxana@example.com",
            "user_sis_id": "456-T45",
            "root_account_id": "21070000000000001",
            "root_account_lti_guid": "VicYj3cu5BIFpoZhDVU4DZumnlBrWi1grgJEzADs.oxana.instructure.com",
            "root_account_uuid": "VicYj3cu5BIFpoZhDVU4DZumnlBrWi1grgJEzADs",
            "entity_id": "21070000000123456"
          }
        }
      },
      "action": "Modified",
      "object": {
        "id": "urn:instructure:canvas:attachment:21070000000000606",
        "type": "Document",
        "name": "enrollments.csv",
        "dateModified": "2018-10-11T20:32:48.000Z",
        "extensions": {
          "com.instructure.canvas": {
            "context_id": "21070000000000565",
            "context_type": "Course",
            "filename": "enrollments.csv",
            "folder_id": "21070000000001344",
            "entity_id": "21070000000000606"
          }
        },
        "mediaType": "text/csv"
      },
      "eventTime": "2019-11-01T19:11:18.234Z",
      "referrer": "https://oxana.instructure.com/courses/565/files",
      "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:user:21070000000123456",
        "type": "Membership",
        "member": {
          "id": "urn:instructure:canvas:user:21070000000123456",
          "type": "Person"
        },
        "organization": {
          "id": "urn:instructure:canvas:course:21070000000000565",