Webhook events¶
exam-play-result¶
Triggers when a user completes an exam. Organization webhooks will only trigger for exams and users that are part of the organization. Any exam result coming from a non-organization user will not trigger the webhook!
[] Payload:
- string play: Quiz play identification string
- string exam: exam identification string
- string user: user identification string
- datetime time_start: start time
- datetime time_end: end time
- integer questions_total: total number of questions asked
- integer questions_correct: number of correctly answered questions
- float points_total: total points
- float points_correct: total points scored
- boolean valid: result is valid
- a result is considered valid if the test has been submitted, all answers are evaluated (either automatically or by a supervisor) and is not marked as invalid by a reason
- boolean/null successful: attempt passed grading threshold (if applicable)
- boolean certified: result is certified
- a result is considered certified if a certificate has been issued at least once
- boolean eligible: result is eligible for certification (all configured conditions are met)
- string certificate_serial: serial number of the certificate
- only present if the result is certified and serial numbering is enabled
- date certificate_expires: date of expiration
- only present if the result is certified and expiration is configured
- string certificate_url: download link for the certificate
- only present if the result is eligible for certification but not yet certified
- download link is valid for 24 hours
quiz-play-result¶
Triggers when a user completes a test in practice mode. Organization webhooks will only trigger for Quiz sets and users that are part of the organization. Any result coming from a non-organization user will not trigger the webhook!
[] Payload:
- string play: Quiz play identification string
- string quiz: quiz identification string
- string user: user identification string
- datetime time_start: start time
- datetime time_end: end time
- integer questions_total: total number of questions asked
- integer questions_correct: number of correctly answered questions
- float points_total: total points
- float points_correct: total points scored
- boolean valid: result is valid
- a result is considered valid if the test has been submitted, all answers are evaluated (either automatically or by a supervisor) and is not marked as invalid by a reason
- boolean/null successful: attempt passed grading threshold (if applicable)