Webhook Protocol

Instead of constantly polling the EduFlow API for changes, you can register Webhook URLs to receive HTTP POST payloads whenever specific events occur in your tenant.

Supported Events

• payment.success - Triggered when a parent completes a tuition payment via Paystack or Monnify.
• student.enrolled - Triggered when a new student is added to the directory.
• attendance.flagged - Triggered when a student is marked absent for 3 consecutive days.
• security.gate_breach - Triggered when an unauthorized exit is attempted via the Gate Control module.

Payload Structure

Every webhook request contains a JSON body with the event type and relevant data.

1{
2  "event": "payment.success",
3  "data": {
4    "student_id": "stu_01HX...",
5    "amount": 45000,
6    "currency": "NGN",
7    "reference": "ref_93jd82...",
8    "timestamp": "2026-04-22T14:30:00Z"
9  }
10}