Webhooks

Student webhooks notify your system when student master data changes or when student-linked manual payments are added, updated, or cancelled.

Use these events to keep your ERP student master data and offline payment records aligned with Jodo. Product events such as Flex, Pay, and Cred still carry product-specific state.

Events

Student

masterdata.student.registered

Triggered when a student is registered with Jodo.

View event → Student

masterdata.student.dropped

Triggered when a student is marked as dropped.

View event → Student

masterdata.student.activated

Triggered when a dropped student is activated again.

View event → Manual Payment

direct.payment.added

Triggered when an institute records an offline payment in Jodo Dashboard.

View event → Manual Payment

direct.payment.cancelled

Triggered when a manual payment is cancelled.

View event → Manual Payment

direct.payment.updated

Triggered when a manual payment record is updated.

View event →

Common Payload Shape

Attribute	Type	Description
event_id	String	Unique identifier for the webhook delivery. Use this for idempotency.
event	String	The event name, such as masterdata.student.registered.
timestamp	Integer	Unix timestamp when the event was originated.
version	String	Webhook payload version.
payload.jodo_student_id	String	Jodo student identifier. Store this against your ERP student record.
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	Grade information for the student.
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 key-value metadata attached to the student.

Implementation Guidance

• Store the Jodo student ID returned by Student APIs.
• Store your ERP student identifier and custom identifier alongside the Jodo student ID.
• Process events idempotently using event_id.
• Use Student webhooks to update student master data, enrollment state, and student-linked manual payment records.
• Use product webhook payloads to update product state such as subscriptions, payments, and loan applications.
• Use Webhook Integration for reliability and security guidance.