Student Class | DreamClass

Webhook related to student assigned to a class, trigged upon

Student class created: STUDENT_CLASS_CREATED
Student class updated: STUDENT_CLASS_UPDATED
Student class deleted: STUDENT_CLASS_DELETED

The provided classId can be used in the GetPeriodClasses API. The studentPeriodId is the one returned in the Student Period webhook.

Webhook related to student assigned to a class, trigged upon - Student class created: STUDENT_CLASS_CREATED - Student class updated: STUDENT_CLASS_UPDATED - Student class deleted: STUDENT_CLASS_DELETED The provided classId can be used in the GetPeriodClasses API. The studentPeriodId is the one returned in the Student Period webhook.

Request

This endpoint expects an object.

tenantstringRequired

timestampintegerRequired

idstringRequiredformat: "uuid"

signaturestringRequired

typestringRequired

dataobjectRequired

Response

Successful response

1	curl -X POST https://https//https#post3 \
2	-H "Content-Type: application/json" \
3	-d '{
4	"tenant": "my-school",
5	"timestamp": 1727882727528,
6	"id": "613df5f8-c44f-439d-8f94-5c2d87aa18df",
7	"signature": "k1XoUbe5HuuOLbsNqrXRUHhQeDNWWU5eY0h3DfamnjQ=",
8	"type": "STUDENT_CLASS_CREATED",
9	"data": {
10	"id": 45,
11	"registered": true,
12	"startDate": "2023-12-11",
13	"endDate": "2024-10-11",
14	"addedAt": "2024-10-02T15:25:27.471+00:00",
15	"classId": 14,
16	"studentPeriodId": 74
17	}
18	}'