cred.loan.application_started

cred.loan.application_started

Overview

The cred.loan.application_started webhook event is triggered when a customer begins the Cred loan application process.

Payload

Attribute	Type	Description
event_id	String	A unique identifier for the webhook event.
event	String	The event type; in this case, “cred.loan.application_started”
timestamp	Integer	The Unix timestamp when the event was originated.
version	String	The version of the webhook payload format (here, “1.0”).
payload	Object	Detailed information about the event.
payload.jodo_student_id	Integer	The ID of the student in the JODO system.
payload.student	Object	Information about the student.
payload.student.identifier	String	The student’s identifier within your system (if applicable).
payload.student.custom_identifier	String	A custom identifier associated with the student.
payload.student.collector_code	String	Branch code (if applicable).
payload.student.academic_year_start	Integer	The start year of the student’s academic year.
payload.student.academic_year_end	Integer	The end year of the student’s academic year.
payload.student.grade	Object	Information about the student’s grade.
payload.student.grade.name	String	The name of the grade (e.g., “Montessori 1”).
payload.student.grade.code	String	The code representing the grade (e.g., “M1BLUE”).
payload.application	Object	Information about the loan application.
payload.application.id	Integer	The unique loan id in JODO system.
payload.application.status	String	The current status of the loan application.

Example

{
  "event_id": "a9adde44-d03a-4068-8472-4efbc279277d",
  "event": "cred.loan.application_started",
  "timestamp": 1692008248,
  "version": "1.0",
  "payload": {
    "jodo_student_id": 7408,
    "student": {
      "identifier": "Year-2023/Client-appform-extraaedgev2/-2262",
      "custom_identifier": "109072_eaa3c281",
      "collector_code": "appform-extraaedgev2",
      "academic_year_start": 2023,
      "academic_year_end": 2024,
      "grade": {
        "name": "4-IN-1 Professional Diploma in Banking, Financial Services & Insurance (PDBFSI)",
        "code": "3"
      }
    },
    "application": { "id": 1295, "status": "application_started" }
  }
}

Handling the Event

Upon receiving the cred.loan.application_started event, you can update your systems to record that the student has started a Cred loan application.