🔀 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

1. Every day at midnight

   • Webhook Name: cron_midnight
   • Description: This webhook triggers every day at midnight.

2. When a course is created

   • Webhook Name: on_course_created
   • Description: This webhook triggers when a course is created.

3. 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.

4. When a course is edited

   • Webhook Name: on_course_edited
   • Description: This webhook triggers when a course is edited.

5. 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.

6. When a course is deleted

   • Webhook Name: on_course_deleted
   • Description: This webhook triggers when a course is deleted.

7. When a course is locked

   • Webhook Name: on_course_locked
   • Description: This webhook triggers when a course is locked.

8. When an absence report is generated

   • Webhook Name: on_abscence_report_generated
   • Description: This webhook triggers when an absence report is generated.

9. When an absence is justified

   • Webhook Name: on_justified_absence
   • Description: This webhook triggers when an absence is justified.

10. When an absence request is made

    • Webhook Name: on_request_justified_absence
    • Description: This webhook triggers when a justified absence request is made.

11. When a Zoom meeting is created

    • Webhook Name: on_zoom_meeting_created
    • Description: This webhook triggers when a Zoom meeting is created.

12. When a student signs

    • Webhook Name: on_student_sign
    • Description: This webhook triggers when a student signs a document.

13. When a student is created

    • Webhook Name: on_student_created
    • Description: This webhook triggers when a student is created.

14. When a student is edited

    • Webhook Name: on_student_edited
    • Description: This webhook triggers when a student's details are edited.

15. When a student is deleted

    • Webhook Name: on_student_deleted
    • Description: This webhook triggers when a student is deleted.

16. When a student is restored

    • Webhook Name: on_student_unremoved
    • Description: This webhook triggers when a student is restored (unremoved).

17. When a teacher signs

    • Webhook Name: on_teacher_sign
    • Description: This webhook triggers when a teacher signs a document.

18. When a teacher is created

    • Webhook Name: on_teacher_created
    • Description: This webhook triggers when a teacher is created.

19. When a teacher is edited

    • Webhook Name: on_teacher_edited
    • Description: This webhook triggers when a teacher's details are edited.

20. When a teacher is deleted

    • Webhook Name: on_teacher_deleted
    • Description: This webhook triggers when a teacher is deleted.

21. When a teacher is restored

    • Webhook Name: on_teacher_unremoved
    • Description: This webhook triggers when a teacher is restored (unremoved).

22. When a group is created

    • Webhook Name: on_group_created
    • Description: This webhook triggers when a group is created.

23. When a group is edited

    • Webhook Name: on_group_edited
    • Description: This webhook triggers when a group is edited.

24. When a group is deleted

    • Webhook Name: on_group_deleted
    • Description: This webhook triggers when a group is deleted.

25. When a group is restored

    • Webhook Name: on_group_unremoved
    • Description: This webhook triggers when a group is restored (unremoved).

26. When a document is completed

    • Webhook Name: on_document_completed
    • Description: This webhook triggers when a document is completed.

27. When a survey is answered

    • Webhook Name: on_survey_answer
    • Description: This webhook triggers when a survey is answered.

28. When an email is invalid

    • Webhook Name: on_email_invalid
    • Description: This webhook triggers when an email is invalid.

29. When the application parameters are modified

    • Webhook Name: on_app_parameters_changed
    • Description: This webhook triggers when the application parameters are modified.

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"
}