Challenge Assignment

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

See Introduction to Webhooks for details on the user object.

{
  "eventType": "assignmentCreated.challenge",
  "timestamp": 17265103952580,
  "user": {},
  "challenge": {
    "id": "baseba11-d011-ab1e-fe11-1eafb01dface",
    "displayTitle": "An Example Challenge"
  },
  "challengeAssignment": {}
}

challengeAssignment object

idstringunique identifier of the assignment
challengeIdstringunique identifier of the challenge
calculatedGradeintegercalculated grade out of 100 of the assignment
completionPercentageintegerpercentage complete of the assignment
numDaysOverdueinteger(optional) number of days the assignment is overdue
statusstringstatus of the assignment, one of ["not_started", "in_progress", "overdue", "needs_grading", "completed", "failed"]
isCompletedbooleanassignment is completed?
isCompletedOnTimebooleanassignment was completed on time?
isFullyGradedbooleanassignment is fully graded?
isOverduebooleanassignment is overdue?
isPartiallyGradedbooleanassignment is partially graded?
passedbooleanlearned passed the assignment?
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
reviewersDueDateinteger(optional) timestamp when reviewing the assignment is due
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

{
  "challengeAssignment": {
    "id": "0191fc31-c100-75ce-a928-26ceada9e14f",
    "challengeId": "01920b58-e592-7d99-ad37-3e303d1d7139",
    "calculatedGrade": 0,
    "completionPercentage": 0,
    "numDaysOverdue": null,
    "status": "not_started",
    "isCompleted": false,
    "isCompletedOnTime": false,
    "isFullyGraded": false,
    "isOverdue": false,
    "isPartiallyGraded": false,
    "isSubmitted": false,
    "passed": false,
    "completedAt": null,
    "createdAt": 1726358400000,
    "dueDate": 1726531200000,
    "firstViewedAt": null,
    "lastViewedAt": null,
    "reviewersDueDate": null,
    "updatedAt": 1726512764441
  }
}