> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://apidoc.dreamclass.io/dream-class-api/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://apidoc.dreamclass.io/_mcp/server. # Overview > **These are requests DreamClass sends to you.** You register a URL under > **Settings > Integrations** and DreamClass POSTs to it whenever data changes. The pages in > this section document the payload you will receive; the URL shown on each one is a > placeholder for your own endpoint, not a DreamClass address. ## Overview This API provides webhooks to notify external systems upon certain events. The event data is represented by the JSON payload included in the request body. Optionally, the outgoing request can use **Basic Authentication** for security. Additionally, each request may contain a **HMAC hash** for request validation. Finally, this API is supplementary to the DreamClass API, meaning that the entities returned by this API can be used as input to the DreamClass API to retrieve more data. ### Configuration In the DreamClass app, under Settings > Integrations you can configure the webhooks functionality * **URL** - the (http/https) URL that will receive the outgoing requests. * **Username / Password** - optional Basic Authentication credentials for the outgoing requests. * **Secret** - optional HMAC key used to generate the signature. * **Events** - the events that should trigger a webhook. ### HMAC Validation Each request contains a `signature` attribute, which includes the hashed value of the request ID calculated using HMAC with the specified secret key. The server should validate this signature to ensure the request's integrity. * **HMAC Algorithm:** HmacSHA256 * **Key Encoding:** Base64 ### Sample request ```json { "tenant":"my-school", "timestamp":1727862002901, "id":"b3e6fa78-8672-4e8b-8431-7eebdabd25a2", "signature":"nGq8sspzZVWObaR4zUOLyQ29m/IBxxD716hKx5298No=", "type":"STUDENT_PERIOD_CREATED", "data":{ "id":32, "active":true, "studentId":76, "addedAt":"2024-10-02T09:40:02.179+00:00" } } ``` * **id**: The ID of the request. * **signature**: The HMAC hash of the ID. * **type**: The event type. * **tenant**: The DreamClass domain. * **timestamp**: The timestamp of the request. * **data**: A JSON document that contains event data. ### Response The response to the webhook should be HTTP 200; otherwise, it will be marked as failed. The HTTP request must be completed within 10 seconds. Failed requests are retried 3 times before being discarded. ## Docs - [Overview](https://apidoc.dreamclass.io/dream-class-api.md) ## API Docs - [GetAdmissionForm](https://apidoc.dreamclass.io/dream-class-api/admissions/get-admission-form.md): DreamClass API > Admissions - [GetAdmissionApplications](https://apidoc.dreamclass.io/dream-class-api/admissions/get-admission-applications.md): DreamClass API > Admissions - [SubmitToAdmissionForm](https://apidoc.dreamclass.io/dream-class-api/admissions/submit-to-admission-form.md): DreamClass API > Admissions - [UpdateApplicationStatus](https://apidoc.dreamclass.io/dream-class-api/admissions/update-application-status.md): DreamClass API > Admissions - [GetAdmissionStatuses](https://apidoc.dreamclass.io/dream-class-api/admissions/get-admission-statuses.md): DreamClass API > Admissions - [GetAnnouncements](https://apidoc.dreamclass.io/dream-class-api/announcements/get-announcements.md): DreamClass API > Announcements - [GetAssignments](https://apidoc.dreamclass.io/dream-class-api/assignments/get-assignments.md): DreamClass API > Assignments - [GetSubmissions](https://apidoc.dreamclass.io/dream-class-api/assignments/get-submissions.md): DreamClass API > Assignments - [GetAssignment](https://apidoc.dreamclass.io/dream-class-api/assignments/get-assignment.md): DreamClass API > Assignments - [GetAttendanceStatuses](https://apidoc.dreamclass.io/dream-class-api/attendance/get-attendance-statuses.md): DreamClass API > Attendance - [GetLessonAttendance](https://apidoc.dreamclass.io/dream-class-api/attendance/get-lesson-attendance.md): DreamClass API > Attendance - [GetDailyAttendance](https://apidoc.dreamclass.io/dream-class-api/attendance/get-daily-attendance.md): DreamClass API > Attendance - [AddLessonAttendance](https://apidoc.dreamclass.io/dream-class-api/attendance/add-lesson-attendance.md): DreamClass API > Attendance - [DeleteLessonAttendance](https://apidoc.dreamclass.io/dream-class-api/attendance/delete-lesson-attendance.md): DreamClass API > Attendance - [UpdateLessonAttendance](https://apidoc.dreamclass.io/dream-class-api/attendance/update-lesson-attendance.md): DreamClass API > Attendance - [SaveLessonAttendances](https://apidoc.dreamclass.io/dream-class-api/attendance/save-lesson-attendances.md): DreamClass API > Attendance - [AddDailyAttendance](https://apidoc.dreamclass.io/dream-class-api/attendance/add-daily-attendance.md): DreamClass API > Attendance - [DeleteDailyAttendance](https://apidoc.dreamclass.io/dream-class-api/attendance/delete-daily-attendance.md): DreamClass API > Attendance - [UpdateDailyAttendance](https://apidoc.dreamclass.io/dream-class-api/attendance/update-daily-attendance.md): DreamClass API > Attendance - [SaveDailyAttendances](https://apidoc.dreamclass.io/dream-class-api/attendance/save-daily-attendances.md): DreamClass API > Attendance - [GetSingleEvent](https://apidoc.dreamclass.io/dream-class-api/calendar/get-single-event.md): DreamClass API > Calendar - [AddSingleEvent](https://apidoc.dreamclass.io/dream-class-api/calendar/add-single-event.md): DreamClass API > Calendar - [DeleteSingleEvent](https://apidoc.dreamclass.io/dream-class-api/calendar/delete-single-event.md): DreamClass API > Calendar - [UpdateSingleEvent](https://apidoc.dreamclass.io/dream-class-api/calendar/update-single-event.md): DreamClass API > Calendar - [GetRecurringEvents](https://apidoc.dreamclass.io/dream-class-api/calendar/get-recurring-events.md): DreamClass API > Calendar - [AddRecurringEvent](https://apidoc.dreamclass.io/dream-class-api/calendar/add-recurring-event.md): DreamClass API > Calendar - [DeleteRecurringEvent](https://apidoc.dreamclass.io/dream-class-api/calendar/delete-recurring-event.md): DreamClass API > Calendar - [UpdateRecurringEvent](https://apidoc.dreamclass.io/dream-class-api/calendar/update-recurring-event.md): DreamClass API > Calendar - [GetSingleLectures](https://apidoc.dreamclass.io/dream-class-api/calendar/get-single-lectures.md): DreamClass API > Calendar - [AddSingleLecture](https://apidoc.dreamclass.io/dream-class-api/calendar/add-single-lecture.md): DreamClass API > Calendar - [DeleteSingleLecture](https://apidoc.dreamclass.io/dream-class-api/calendar/delete-single-lecture.md): DreamClass API > Calendar - [UpdateSingleLecture](https://apidoc.dreamclass.io/dream-class-api/calendar/update-single-lecture.md): DreamClass API > Calendar - [GetRecurringLectures](https://apidoc.dreamclass.io/dream-class-api/calendar/get-recurring-lectures.md): DreamClass API > Calendar - [AddRecurringLecture](https://apidoc.dreamclass.io/dream-class-api/calendar/add-recurring-lecture.md): DreamClass API > Calendar - [DeleteRecurringLecture](https://apidoc.dreamclass.io/dream-class-api/calendar/delete-recurring-lecture.md): DreamClass API > Calendar - [UpdateRecurringLecture](https://apidoc.dreamclass.io/dream-class-api/calendar/update-recurring-lecture.md): DreamClass API > Calendar - [GetSchoolPeriods](https://apidoc.dreamclass.io/dream-class-api/curriculum/get-school-periods.md): DreamClass API > Curriculum - [GetSchoolCourses](https://apidoc.dreamclass.io/dream-class-api/curriculum/get-school-courses.md): DreamClass API > Curriculum - [GetPeriodClasses](https://apidoc.dreamclass.io/dream-class-api/curriculum/get-period-classes.md): DreamClass API > Curriculum - [GetPeriodClassCourses](https://apidoc.dreamclass.io/dream-class-api/curriculum/get-period-class-courses.md): DreamClass API > Curriculum - [Levels](https://apidoc.dreamclass.io/dream-class-api/curriculum/levels.md): DreamClass API > Curriculum - [CreateCourse](https://apidoc.dreamclass.io/dream-class-api/curriculum/create-course.md): DreamClass API > Curriculum - [CreateClass](https://apidoc.dreamclass.io/dream-class-api/curriculum/create-class.md): DreamClass API > Curriculum - [GetPeriodFees](https://apidoc.dreamclass.io/dream-class-api/fees/get-period-fees.md): DreamClass API > Fees - [CreateFees](https://apidoc.dreamclass.io/dream-class-api/fees/create-fees.md): DreamClass API > Fees - [AssignFees](https://apidoc.dreamclass.io/dream-class-api/fees/assign-fees.md): DreamClass API > Fees - [UnassignFees](https://apidoc.dreamclass.io/dream-class-api/fees/unassign-fees.md): DreamClass API > Fees - [UpdateFees](https://apidoc.dreamclass.io/dream-class-api/fees/update-fees.md): DreamClass API > Fees - [DeleteFees](https://apidoc.dreamclass.io/dream-class-api/fees/delete-fees.md): DreamClass API > Fees - [GradeMapping](https://apidoc.dreamclass.io/dream-class-api/grading/grade-mapping.md): DreamClass API > Grading - [Gradebook](https://apidoc.dreamclass.io/dream-class-api/grading/gradebook.md): DreamClass API > Grading - [AddGradebook](https://apidoc.dreamclass.io/dream-class-api/grading/add-gradebook.md): DreamClass API > Grading - [GradebookGradeValues](https://apidoc.dreamclass.io/dream-class-api/grading/gradebook-grade-values.md): DreamClass API > Grading - [AddGradebookGrade](https://apidoc.dreamclass.io/dream-class-api/grading/add-gradebook-grade.md): DreamClass API > Grading - [AddGradebookGradeValue](https://apidoc.dreamclass.io/dream-class-api/grading/add-gradebook-grade-value.md): DreamClass API > Grading - [DeleteGradebookGradeValue](https://apidoc.dreamclass.io/dream-class-api/grading/delete-gradebook-grade-value.md): DreamClass API > Grading - [UpdateGradebookGradeValue](https://apidoc.dreamclass.io/dream-class-api/grading/update-gradebook-grade-value.md): DreamClass API > Grading - [GetInvoice](https://apidoc.dreamclass.io/dream-class-api/invoices/get-invoice.md): DreamClass API > Invoices - [GetPaymentMethods](https://apidoc.dreamclass.io/dream-class-api/invoices/get-payment-methods.md): DreamClass API > Invoices - [UpdateInvoice](https://apidoc.dreamclass.io/dream-class-api/invoices/update-invoice.md): DreamClass API > Invoices - [UpdatePayment](https://apidoc.dreamclass.io/dream-class-api/invoices/update-payment.md): DreamClass API > Invoices - [DeleteInvoice](https://apidoc.dreamclass.io/dream-class-api/invoices/delete-invoice.md): DreamClass API > Invoices - [GetInvoices](https://apidoc.dreamclass.io/dream-class-api/invoices/get-invoices.md): DreamClass API > Invoices - [PayInvoice](https://apidoc.dreamclass.io/dream-class-api/invoices/pay-invoice.md): DreamClass API > Invoices - [CreateInvoice](https://apidoc.dreamclass.io/dream-class-api/invoices/create-invoice.md): DreamClass API > Invoices - [GetPayment](https://apidoc.dreamclass.io/dream-class-api/invoices/get-payment.md): DreamClass API > Invoices - [GetInvoicePayments](https://apidoc.dreamclass.io/dream-class-api/invoices/get-invoice-payments.md): DreamClass API > Invoices - [Notes](https://apidoc.dreamclass.io/dream-class-api/notes/notes.md): DreamClass API > Notes - [AddNote](https://apidoc.dreamclass.io/dream-class-api/notes/add-note.md): DreamClass API > Notes - [UpdateNote](https://apidoc.dreamclass.io/dream-class-api/notes/update-note.md): DreamClass API > Notes - [GetProfessors](https://apidoc.dreamclass.io/dream-class-api/professors/get-professors.md): DreamClass API > Professors - [CreateProfessor](https://apidoc.dreamclass.io/dream-class-api/professors/create-professor.md): DreamClass API > Professors - [AssignProfessor](https://apidoc.dreamclass.io/dream-class-api/professors/assign-professor.md): DreamClass API > Professors - [GetProfessor](https://apidoc.dreamclass.io/dream-class-api/professors/get-professor.md): DreamClass API > Professors - [UpdateProfessor](https://apidoc.dreamclass.io/dream-class-api/professors/update-professor.md): DreamClass API > Professors - [Tags](https://apidoc.dreamclass.io/dream-class-api/settings/tags.md): DreamClass API > Settings - [GetStudent](https://apidoc.dreamclass.io/dream-class-api/students/get-student.md): DreamClass API > Students - [GetStudents](https://apidoc.dreamclass.io/dream-class-api/students/get-students.md): DreamClass API > Students - [GetCustomFields](https://apidoc.dreamclass.io/dream-class-api/students/get-custom-fields.md): DreamClass API > Students - [GetRelations](https://apidoc.dreamclass.io/dream-class-api/students/get-relations.md): DreamClass API > Students - [GetPeriodStudents](https://apidoc.dreamclass.io/dream-class-api/students/get-period-students.md): DreamClass API > Students - [CreateStudent](https://apidoc.dreamclass.io/dream-class-api/students/create-student.md): DreamClass API > Students - [EnrollClass](https://apidoc.dreamclass.io/dream-class-api/students/enroll-class.md): DreamClass API > Students - [EnrollClassCourse](https://apidoc.dreamclass.io/dream-class-api/students/enroll-class-course.md): DreamClass API > Students - [ConnectGuardian](https://apidoc.dreamclass.io/dream-class-api/students/connect-guardian.md): DreamClass API > Students - [PeriodStudentLevel](https://apidoc.dreamclass.io/dream-class-api/students/period-student-level.md): DreamClass API > Students - [UpdateStudent](https://apidoc.dreamclass.io/dream-class-api/students/update-student.md): DreamClass API > Students - [GetStudentGuardians](https://apidoc.dreamclass.io/dream-class-api/students/get-student-guardians.md): DreamClass API > Students - [Student](https://apidoc.dreamclass.io/dream-class-api/webhooks/student.md): DreamClass API > Webhooks - [Student Period](https://apidoc.dreamclass.io/dream-class-api/webhooks/student-period.md): DreamClass API > Webhooks - [Student Class](https://apidoc.dreamclass.io/dream-class-api/webhooks/student-class.md): DreamClass API > Webhooks - [Student Course](https://apidoc.dreamclass.io/dream-class-api/webhooks/student-course.md): DreamClass API > Webhooks - [Period](https://apidoc.dreamclass.io/dream-class-api/webhooks/period.md): DreamClass API > Webhooks - [School](https://apidoc.dreamclass.io/dream-class-api/webhooks/school.md): DreamClass API > Webhooks - [Course](https://apidoc.dreamclass.io/dream-class-api/webhooks/course.md): DreamClass API > Webhooks - [Class](https://apidoc.dreamclass.io/dream-class-api/webhooks/class.md): DreamClass API > Webhooks - [Invoice](https://apidoc.dreamclass.io/dream-class-api/webhooks/invoice.md): DreamClass API > Webhooks - [Payment](https://apidoc.dreamclass.io/dream-class-api/webhooks/payment.md): DreamClass API > Webhooks - [Admission Form](https://apidoc.dreamclass.io/dream-class-api/webhooks/admission-form.md): DreamClass API > Webhooks - [Admission Application](https://apidoc.dreamclass.io/dream-class-api/webhooks/admission-application.md): DreamClass API > Webhooks - [Attendance](https://apidoc.dreamclass.io/dream-class-api/webhooks/attendance.md): DreamClass API > Webhooks ## OpenAPI Specification - [OpenAPI JSON](https://apidoc.dreamclass.io/openapi.json): raw OpenAPI 3.1 specification for this API, JSON format - [OpenAPI YAML](https://apidoc.dreamclass.io/openapi.yaml): raw OpenAPI 3.1 specification for this API, YAML format