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)
journey-completed¶
Triggers when a user finishes an exam journey by reaching its end. Journeys stopped by an educator or by the visit limit of the journey do not trigger the webhook. Organization webhooks will only trigger for journeys started by an exam of the organization and users that are part of the organization. Any journey finished by a non-organization user will not trigger the webhook!
[] Payload:
- string exam: exam identification string of the starting exam
- string journey: title of the journey
- string user: user identification string
- integer run: index of the run of the journey (increased when the journey is restarted)
- string outcome: outcome of the journey
- the outcome configured for the end of the journey that was reached: completed, failed, or a custom outcome
- completed if the journey was finished through an unconnected output
- integer steps_completed: number of the different exam, class and Quiz set steps completed (the starting exam included)
- datetime time_start: start time of the journey
- datetime time_end: end time of the journey