Path/Training Series Assignment

assignmentCreated.path/assignmentCompleted.path/ assignmentDeleted.path webhook events

See Introduction to Webhooks for details on the user object.

{
  "eventType": "assignmentCreated.path",
  "timestamp": 17265103952580,
  "user": {},
  "path": {
    "id": "baseba11-f00d-c0de-beef-b1adeddecade",
    "displayTitle": "An Example Path",
    "totalTimeEstimate": 1234
  },
  "pathAssignment": {},
  "assignmentCompletionUserReportUrl": "url to view the user's assignment report"
}

`path` fields

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

`pathAssignment` object

Field	Type	Description
`id`	string	unique identifier of the assignment
`assignedFrom`	integer	(optional) where the assignment was assigned from
`assignerId`	integer	(optional) unique identifier of the assigning user
`completionPercentage`	integer	percentage complete of the assignment
`numModules`	integer	number of modules
`numModulesCompleted`	integer	number of modules completed
`numModulesFailed`	integer	number of modules failed
`numModulesGraded`	integer	number of modules graded
`overallGrade`	integer	(optional) overall 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
`isArchived`	boolean	assignment is archived?
`isBulkCompleting`	boolean	assignment is bulk completing?
`isCompleted`	boolean	assignment is completed?
`isFailed`	boolean	assignment is failed?
`isPassed`	boolean	assignment is passed?
`isSubmittedOnTime`	boolean	(optional) was the assignment submitted on time?
`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
`firstViewedAt`	integer	(optional) timestamp when the assignment was first viewed by the user
`updatedAt`	integer	timestamp 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

{
  "assignment": {
    "id": "01920102-13fa-753c-9e88-285d92558c09",
    "assignedFrom": "admin_console",
    "assignerId": 2,
    "completionPercentage": 0,
    "isArchived": false,
    "isBulkCompleting": false,
    "isCompleted": false,
    "isCompleted": false,
    "isFailed": false,
    "isSubmittedOnTime": null,
    "numModules": 1,
    "numModulesCompleted": 0,
    "numModulesFailed": 0,
    "numModulesGraded": 0,
    "overallGrade": null,
    "status": "not_started",
    "completedAt": null,
    "createdAt": 1726593766394,
    "dueDate": null,
    "expiresAt": 1726691922042,
    "firstViewedAt": null,
    "updatedAt": 1726593766394
  }
}