Overview

Webhooks allow you to receive real-time updates when GPA reports and digital evaluations are created or updated.

Available Events

Based on current system behavior:

GPA Reports

• gpa_report.created (data)
• gpa_report.updated (data)
• gpa_report.created (pdf)
• gpa_report.updated (pdf)

Digital Evaluations

• digital_evaluation.created (data)
• digital_evaluation.updated (data)
• digital_evaluation.created (pdf)
• digital_evaluation.updated (pdf)

Setup Steps

1. Identify the events you want to monitor
2. Create a publicly accessible HTTPS endpoint
3. Handle incoming requests and parse payloads
4. Return HTTP 200 OK
5. Register your endpoint in the Developer dashboard

Event Structure

{
  "object": "event",
  "type": "gpa_report.created",
  "data": {
    ...
  }
}

GPA Report Object

{
  "id": 192904,
  "report_name": "Bachelor of Architecture",
  "full_name": "Aleks M",
  "date": "2022-04-23T03:11:34.09",
  "dob": "12/1/1980",
  "cust_field1": "1234567",
  "cust_field2": "001234567",
  "cust_field3": "2",
  "country": "India",
  "institution": "Osmania University",
  "qualification": "Bachelor of Commerce",
  "subject": "Finance",
  "grading_scale": "Most Common",
  "gpa": 3.769,
  "total_credits": 13.0,
  "total_points": 15.0
}

Digital Evaluation Object

{
  "id": 113945,
  "report_name": "Equivalency Report",
  "full_name": "Alex M",
  "date": "2022-09-26T00:14:41.25",
  "cust_field1": "1234567",
  "cust_field2": "001234567",
  "cust_field3": "2",
  "country": "India",
  "credential": "Bachelor of Architecture",
  "program_length": 5.0,
  "equivalency": "Bachelor's Degree",
  "gpa_report": 192904
}

Webhook Security (HMAC Validation)

To verify webhook authenticity:

1. Read the raw request body
2. Extract header:

X-Scholaro-Signature

3. Generate HMAC SHA256 using your signing secret
4. Encode as Base64
5. Compare with header value

Best Practices

• Return HTTP 200 OK immediately
• Process asynchronously when possible
• Log all webhook events
• Handle retries and duplicates safely

Developer Dashboard

https://www.scholaro.com/app/developer/webhooks