SCORM Assignment

assignmentCreated.scorm/assignmentCompleted.scorm/assignmentProgress.scorm / assignmentDeleted.scorm webhook events

See Introduction to Webhooks for details on the user object.

{
  "eventType": "assignmentCreated.scorm",
  "timestamp": 17265103952580,
  "user": {},
  "scorm": {
    "id": "b01dface-deb8-c01d-c0a1-c0a1baseba11",
    "displayTitle": "An Example SCORM",
    "timeEstimateSeconds": 1234
  },
  "scormAssignment": {}
}

scorm fields

FieldTypeDescription
idstringunique identifier of the SCORM
displayTitlestringdisplay title of the SCORM
timeEstimateSecondsintegertime estimate in seconds to complete the SCORM

scormAssignment fields

idstringunique identifier of the assignment
assignedFrominteger(optional) where the assignment was assigned from. one of ["admin_console", "learner_side"]
completionPercentageintegerpercentage complete of the assignment
internalAssignerIdinteger(optional) unique identifier of the assigning user
scoreinteger(optional) calculated grade out of 100 of the assignment
statusstringstatus of the assignment. one of ["assigned", "not_started", "in_progress", "overdue", "needs_grading", "completed", "failed"]
timeSpentintegertime spent on this assignment in seconds
isCompletedbooleanassignment is completed?
isPassedbooleanassignment is passed?
completedAtinteger(optional) timestamp when the assignment was completed
createdAtintegertimestamp when the assignment was created
dueDateinteger(optional) timestamp when the assignment is due
firstViewedAtinteger(optional) timestamp when the assignment was first viewed by the user
lastViewedAtinteger(optional) timestamp when the assignment was last viewed by the user
updatedAtintegertimestamp when the assignment was last updated
📘

Timestamps

Timestamps are UNIX-style with milliseconds, eg 1675816954321 is Wed Feb 08 2023 00:42:34 GMT+0000

Example JSON

{
  "scormAssignment": {
    "id": "019200fd-9353-72f7-b8d8-9e5111745c28",
    "assignedFrom": "admin_console",
    "completionPercentage": 0,
    "internalAssignerId": 1,
    "isCompleted": false,
    "isPassed": false,
    "score": 0,
    "status": "assigned",
    "timeSpent": 0,
    "completedAt": null,
    "createdAt": 1726593471315,
    "dueDate": null,
    "firstViewedAt": null,
    "lastViewedAt": null,
    "updatedAt": 1726593471315
  }
}