Events

socratease gives you a variety of webhooks you can listen to, to notify your application that an event has occurred currently, socratease supports webhooks for events on assessments and units the events are mentioned below unit events unit created unit created emitted when a unit is created the payload below gives you the details of the unit created unit created { "data" { "int id" 10, "unit id" "abc def ghi", "title" "python quiz", "type" "quiz", //can be 'quiz', 'lesson', 'question bank', etc "meta data" { "thumbnail" "https //cdn socratease co/abc png" }, "access level" "logged in", //must be logged in to attempt it "settings" { "randomize options" true, "disable copy paste" false }, }, "event type" "unit created" } unit deleted unit deleted emitted when a unit is deleted the payload below gives you the unit id of the unit which has been deleted unit deleted { "data" { "unit id" "abc def ghi", }, "event type" "unit deleted" } unit started unit started emitted when a user starts attempting a unit the payload below gives you the details of the when the unit was started, and the user's details unit started { "data" { "unit id" "abc def ghi", "started at" "2023 02 14t06 22 58+00 00", "user" { "email" "abcd\@gmail com", "user id" "axsweqw", "username" "abcd\@gmail com", } }, "event type" "unit started" } unit submitted unit submitted emitted when a user submits a unit the payload below gives you the details of the assessment submission, and the user's details unit submitted { "data" { "unit id" "abc def ghi", "started at" "2023 02 14t06 12 58+00 00", "finished at" "2023 02 14t06 14 35+00 00", "points aggregate" 70, "percentage decimal" 0 7, "total points" 100, "grade finalized" true, "attempt num" 1, "unit type" "quiz", "user" { "user id" "axsweqw", "username" "abcd\@gmail com", "email" "abcd\@gmail com", } }, "event type" "unit submitted" } assessment events assessment created assessment created emitted when an assessment is created the payload below gives you all the details of the assessment which is created and the units present within the assessment assessment created { "data" { "access level" public, "assessment id" "kpu nsg hoi", "event type" "assessment created" "max attempts" 1, "meta data" {"thumbnail url" "https //image com"}, "settings" { "auto submit"\ false, }, "status" active "title" "your assessment title" "units" \[ { "title" "test 1", "unit id" "ntg wtk pfk", "type" "quiz", "meta data" { "thumbnail url" "https //image2 com", }, "weightage" 10000 } ] }, "event type" "assessment created" } assessment deleted assessment deleted emitted when an assessment is deleted the payload below gives you assessment id of the assessment which has been deleted assessment deleted { "data" { "assessment id" "kpu nsg hoi", }, "event type" "assessment deleted" } assessment started assessment started emitted when a user starts attempting an assessment the payload below gives you the details of the when the assessment was started, and the user's details assessment started { "data" { "assessment id" "kpu nsg hoi", "started at" "2023 02 14t06 22 58+00 00", "user" { "email" "abcd\@gmail com", "user id" "axsweqw", "username" "abcd\@gmail com", } }, "event type" "assessment started" } assessment submitted assessment submitted emitted when a user submits an assessment the payload below gives you the details of the assessment submission, and the user's details assessment submitted { "data" { "assessment id" "kpu nsg hoi", "started at" "2023 02 14t06 12 58+00 00", "finished at" "2023 02 14t06 14 35+00 00", "overall score" 7000, "grade finalized" true, "attempt num" 1, "unit results" \[ { "unit id" "agh wwq njw", "points aggregate" 70", "total points" 100, "percentage decimal" 0 7 } ] "user" { "user id" "axsweqw", "username" "abcd\@gmail com", "email" "abcd\@gmail com", } }, "event type" "assessment submitted" }