masterdata.student.registered
The masterdata.student.registered event is triggered when a student is registered with Jodo.
Overview
Section titled “Overview”Use this event to create or update the corresponding student record in your ERP and store the Jodo student ID for future API and webhook reconciliation.
Payload
Section titled “Payload”| Attribute | Type | Description |
|---|---|---|
event_id | String | Unique identifier for the webhook event. |
event | String | Event name: masterdata.student.registered. |
timestamp | Integer | Unix timestamp when the event was originated. |
version | String | Webhook payload version. |
payload | Object | Event payload. |
payload.jodo_student_id | String | Jodo student identifier. |
payload.student | Object | Student profile details. |
payload.student.identifier | String | Student identifier from your system. |
payload.student.custom_identifier | String | Optional custom identifier associated with the student. |
payload.student.collector_code | String or null | Collector or branch code, when configured. |
payload.student.grade | Object | Student grade details. |
payload.student.grade.code | String | Grade code. |
payload.student.grade.name | String | Grade name. |
payload.student.academic_year_start | Integer | Start year of the student’s academic year. |
payload.student.academic_year_end | Integer | End year of the student’s academic year. |
payload.student.primary_contact_number | String | Primary parent or guardian contact number. |
payload.student.primary_contact_email | String | Primary parent or guardian email address. |
payload.student.notes | Array | Additional student metadata. |
payload.student.notes[].key | String | Metadata key. |
payload.student.notes[].value | String | Metadata value. |
Example
Section titled “Example”{ "event": "masterdata.student.registered", "event_id": "f8093bb5-29c7-4b3a-a99b-298520233820", "version": "1.0", "timestamp": 1655448963, "payload": { "jodo_student_id": "student_1234", "student": { "identifier": "1234", "custom_identifier": "cust_1234", "collector_code": null, "grade": { "code": "M1BLUE", "name": "Montessori 1" }, "academic_year_start": 2022, "academic_year_end": 2023, "primary_contact_number": "9876543210", "primary_contact_email": "parent@example.com", "notes": [ { "key": "registration_number", "value": "REG12345" } ] } }}Handling the Event
Section titled “Handling the Event”- Upsert the student record in your ERP using
payload.jodo_student_id,payload.student.identifier, orpayload.student.custom_identifier. - Store the Jodo student ID against your ERP student record.
- Treat repeated deliveries with the same
event_idas duplicates. - Do not infer payment, subscription, or loan state from this event; use product webhooks for product lifecycle updates.