๐ Webhooks Documentation
Webhooks Documentation
Webhooks are used to notify an external application or service when a specific event occurs on the platform. Each webhook is associated with an event, and it can be configured to call an external URL to provide detailed information about the event.
List of Webhooks
-
Every day at midnight
- Webhook Name:
cron_midnight - Description: This webhook triggers every day at 00:07 UTC.
- Webhook Name:
-
When a course is created
- Webhook Name:
on_course_created - Description: This webhook triggers when a course is created.
- Webhook Name:
-
When a course is starting
- Webhook Name:
on_course_start - Description: This webhook triggers when a course session starts.
- Tips : This webhook may be 1 to 5 minutes behind the real time.
- Webhook Name:
-
When a course is edited
- Webhook Name:
on_course_edited - Description: This webhook triggers when a course is edited.
- Webhook Name:
-
When a course is ending
- Webhook Name:
on_course_end - Description: This webhook triggers when a course session ends.
- Tips : This webhook may be 1 to 5 minutes behind the real time.
- Webhook Name:
-
When a course is deleted
- Webhook Name:
on_course_deleted - Description: This webhook triggers when a course is deleted.
- Webhook Name:
-
When a course is locked
- Webhook Name:
on_course_locked - Description: This webhook triggers when a course is locked.
- Webhook Name:
-
When an absence report is generated
- Webhook Name:
on_abscence_report_generated - Description: This webhook triggers when an absence report is generated.
- Webhook Name:
-
When an absence is justified
- Webhook Name:
on_justified_absence - Description: This webhook triggers when an absence is justified.
- Webhook Name:
-
When an absence request is made
- Webhook Name:
on_request_justified_absence - Description: This webhook triggers when a justified absence request is made.
- Webhook Name:
-
When a Zoom meeting is created
- Webhook Name:
on_zoom_meeting_created - Description: This webhook triggers when a Zoom meeting is created.
- Webhook Name:
-
When a student signs
- Webhook Name:
on_student_sign - Description: This webhook triggers when a student signs a document.
- Webhook Name:
-
When a student is created
- Webhook Name:
on_student_created - Description: This webhook triggers when a student is created.
- Webhook Name:
-
When a student is edited
- Webhook Name:
on_student_edited - Description: This webhook triggers when a student's details are edited.
- Webhook Name:
-
When a student is deleted
- Webhook Name:
on_student_deleted - Description: This webhook triggers when a student is deleted.
- Webhook Name:
-
When a student is restored
- Webhook Name:
on_student_unremoved - Description: This webhook triggers when a student is restored (unremoved).
- Webhook Name:
-
When a teacher signs
- Webhook Name:
on_teacher_sign - Description: This webhook triggers when a teacher signs a document.
- Webhook Name:
-
When a teacher is created
- Webhook Name:
on_teacher_created - Description: This webhook triggers when a teacher is created.
- Webhook Name:
-
When a teacher is edited
- Webhook Name:
on_teacher_edited - Description: This webhook triggers when a teacher's details are edited.
- Webhook Name:
-
When a teacher is deleted
- Webhook Name:
on_teacher_deleted - Description: This webhook triggers when a teacher is deleted.
- Webhook Name:
-
When a teacher is restored
- Webhook Name:
on_teacher_unremoved - Description: This webhook triggers when a teacher is restored (unremoved).
- Webhook Name:
-
When a group is created
- Webhook Name:
on_group_created - Description: This webhook triggers when a group is created.
- Webhook Name:
-
When a group is edited
- Webhook Name:
on_group_edited - Description: This webhook triggers when a group is edited.
- Webhook Name:
-
When a group is deleted
- Webhook Name:
on_group_deleted - Description: This webhook triggers when a group is deleted.
- Webhook Name:
-
When a group is restored
- Webhook Name:
on_group_unremoved - Description: This webhook triggers when a group is restored (unremoved).
- Webhook Name:
-
When a document is completed
- Webhook Name:
on_document_completed - Description: This webhook triggers when a document is completed.
- Webhook Name:
-
When a survey is answered
- Webhook Name:
on_survey_answer - Description: This webhook triggers when a survey is answered.
- Webhook Name:
-
When an email is invalid
- Webhook Name:
on_email_invalid - Description: This webhook triggers when an email is invalid.
- Webhook Name:
-
When the application parameters are modified
- Webhook Name:
on_app_parameters_changed - Description: This webhook triggers when the application parameters are modified.
- Webhook Name:
-
When a document participant signs
- Webhook Name:
on_document_participant_signed - Description: This webhook triggers when a participant signs a document.
- Webhook Name:
-
When a student is archived
- Webhook Name:
on_student_archived - Description: This webhook triggers when a student is archived.
- Webhook Name:
-
When an archived student is restored
- Webhook Name:
on_student_unarchived - Description: This webhook triggers when an archived student is restored.
- Webhook Name:
-
When a student is excluded from a course
- Webhook Name:
on_student_excluded_from_course - Description: This webhook triggers when a student is excluded from a course.
- Webhook Name:
-
When a course is unlocked
- Webhook Name:
on_course_unlocked - Description: This webhook triggers when a locked course is unlocked.
- Webhook Name:
-
When a training is starting
- Webhook Name:
on_training_started - Description: This webhook triggers when a training starts.
- Webhook Name:
-
When a training is ending
- Webhook Name:
on_training_ended - Description: This webhook triggers when a training ends.
- Webhook Name:
-
When a training is archived
- Webhook Name:
on_training_archived - Description: This webhook triggers when a training is archived through the API v3.
- Webhook Name:
-
When a document is sent
- Webhook Name:
on_document_sent - Description: This webhook triggers each time a document is sent to a recipient, with or without signature.
- Webhook Name:
-
When a document requiring a signature is sent
- Webhook Name:
on_document_with_signature_sent - Description: This webhook triggers when a document requiring a signature is sent to a recipient.
- Webhook Name:
-
When a document not requiring a signature is sent
- Webhook Name:
on_document_without_signature_sent - Description: This webhook triggers when a document that does not require a signature is sent to a recipient.
- Webhook Name:
-
When a document is refused
- Webhook Name:
on_document_refused - Description: This webhook triggers when a recipient refuses to sign a document.
- Webhook Name:
-
When a document expires
- Webhook Name:
on_document_expired - Description: This webhook triggers when a document reaches its expiration date.
- Webhook Name:
-
When a survey is sent
- Webhook Name:
on_survey_sent - Description: This webhook triggers when a survey is sent to a recipient.
- Webhook Name:
-
When a scheduled survey is sent
- Webhook Name:
on_scheduled_survey_sent - Description: This webhook triggers when a scheduled survey is automatically sent to its recipients.
- Webhook Name:
Example of Webhook Headers and Body
Headers
{
"x-edusign-webhook-type": "on_course_created",
"x-edusign-school-id": "school_id_placeholder",
"x-edusign-app-id": "app_id_placeholder",
"x-edusign-lang": "en",
"x-edusign-hmac": "hmac_placeholder",
"x-edusign-client-id": "client_id_placeholder",
}Body
{
"type": "on_course_created",
"appId": "app_id_placeholder",
"courseId": "course_id_placeholder"
}Updated about 1 month ago

