Course/Guide Assignment

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

See Introduction to Webhooks for details on the user object.

{
  "eventType": "assignmentCreated.guide",
  "timestamp": 17265103952580,
  "user": {},
  "guide": {
    "id": "b01dface-1eaf-b01d-dead-b01dfacef00d",
    "displayTitle": "An Example Guide",
    "timeEstimateSeconds": 1234
  },
  "guideAssignment": {}
}

`guide` fields

Field	Type	Description
`id`	string	unique identifier of the guide
`displayTitle`	string	display title of the guide
`timeEstimateSeconds`	integer	time estimate in seconds to complete the guide

`guideAssignment` fields

Field	Type	Description
`id`	string	unique identifier of the assignment
`pathId`	string	(optional) unique identifier of the associated Path/Training Series
`pathAssignmentId`	string	(optional) unique identifier of the learner's assignment to the associated Path/Training Series
`completionPercentage`	integer	percentage of tasks the learner has completed
`numCompletedTasks`	integer	number of tasks the learner has completed
`numCompletedTestQuestions`	integer	number of test questions the learner has completed
`numCorrectTestQuestions`	integer	number of test questions the learner got correct
`numGradedTestQuestions`	integer	number of test questions that have been graded
`numViewedTasks`	integer	number of tasks the learner has viewed
`overrideScore`	float	(optional) overridden score
`score`	integer	(optional) calculated grade out of 100 of the assignment
`status`	string	status of the assignment. one of `["assigned", "not_started", "in_progress", "overdue", "needs_grading", "completed", "failed"]`
`timeSpent`	integer	time spent on the assignment in seconds
`rating`	integer	1,2,3,4, or 5 if the learner gave the guide a star rating after completing it ⭐ ⭐ ⭐ ⭐ ⭐ Or `null` if learner did not click a rating
`isCompleted`	boolean	assignment is completed?
`isCompletedAndPassed`	boolean	assignment is completed and passed?
`isMandatory`	boolean	assignment is mandatory?
`completedAt`	integer	(optional) timestamp when the assignment was completed
`createdAt`	integer	timestamp when the assignment was created
`dueDate`	integer	(optional) timestamp when the assignment is due
`expiresAt`	integer	(optional) timestamp when the assignment will expire
`lastViewedAt`	integer	(optional) timestamp when the assigned content was last viewed
`updatedAt`	integer	timestamp when the assignment was last updated
`esignatures`	array	array of esignature objects

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

Example JSON

{
  "guideAssignment": {
    "id": "019200e5-ef7b-79f6-8e41-b6912ca5259d",
    "pathId": "019200e5-ef0c-7303-bf8a-cafe0e121b0b",
    "pathAssignmentId": "019200e5-ef0c-7303-bf8a-cafe0e121b0b",
    "completionPercentage": 0,
    "numCompletedTasks": 0,
    "numCompletedTestQuestions": null,
    "numCorrectTestQuestions": 0,
    "numGradedTestQuestions": 0,
    "numViewedTasks": 1,
    "overrideScore": null,
    "score": null,
    "status": "assigned",
    "timeSpent": 123,
    "rating": 3,
    "isCompleted": false,
    "isCompletedAndPassed": false,
    "isMandatory": null,
    "completedAt": null,
    "createdAt": 1726591922042,
    "dueDate": null,
    "expiresAt": 1726691922042,
    "lastViewedAt": null,
    "updatedAt": 1726591922042,
    "esignatures": [
      {
        "id": "019200e5-ef0c-7303-bf8a-cafe0e12124s",
        "dateSigned": 1730828389024,
        "signedBy": "John Smith",
        "userIpAddress": "172.22.1.4"
      }
     ]
  }
}