Scholaro Webhooks - Developer Documentation for GPA Reports and Digital Evaluations

Receive GPA Reports and Digital Evaluations via Webhooks

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

  1. {
  2.   "object": "event",
  3.   "type": "gpa_report.created",
  4.   "data": {
  5.     ...
  6.   }
  7. }
FieldDescription
objectAlways "event"
typeEvent name
dataPayload

GPA Report Object

  1. {
  2.   "id": 192904,
  3.   "report_name": "Bachelor of Architecture",
  4.   "full_name": "Aleks M",
  5.   "date": "2022-04-23T03:11:34.09",
  6.   "dob": "12/1/1980",
  7.   "cust_field1": "1234567",
  8.   "cust_field2": "001234567",
  9.   "cust_field3": "2",
  10.   "country": "India",
  11.   "institution": "Osmania University",
  12.   "qualification": "Bachelor of Commerce",
  13.   "subject": "Finance",
  14.   "grading_scale": "Most Common",
  15.   "gpa": 3.769,
  16.   "total_credits": 13.0,
  17.   "total_points": 15.0
  18. }

Digital Evaluation Object

  1. {
  2.   "id": 113945,
  3.   "report_name": "Equivalency Report",
  4.   "full_name": "Alex M",
  5.   "date": "2022-09-26T00:14:41.25",
  6.   "cust_field1": "1234567",
  7.   "cust_field2": "001234567",
  8.   "cust_field3": "2",
  9.   "country": "India",
  10.   "credential": "Bachelor of Architecture",
  11.   "program_length": 5.0,
  12.   "equivalency": "Bachelor's Degree",
  13.   "gpa_report": 192904
  14. }

Webhook Security (HMAC Validation)

To verify webhook authenticity:

  1. Read the raw request body
  2. Extract header: 
X-Scholaro-Signature
  1. Generate HMAC SHA256 using your signing secret
  2. Encode as Base64
  3. 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

    • Related Articles

    • GPA Report Integration Guide

      Overview The Scholaro GPA Report integration allows institutions to automatically generate GPA reports from transcripts using multiple methods depending on their workflow. You can choose from the following options: API (Single Report) - create one ...

    • Scholaro Premium (for students): Payment Options for GPA Reports

      What payment methods can I use for Scholaro Premium (Individual)? For Scholaro Premium (Individual) GPA reports, you can choose from several secure and convenient payment options: Credit and Debit Cards We accept the following cards: - Visa - ...

    • Ordering a GPA Report

      Go to https://www.scholaro.com/premium/ Click 'Get Premium' Choose “One Report” for calculating the GPA and degree equivalency, or Yearly Access if you wish to create multiple Premium reports of future use. Create your account with your username, ...

    • Ordering a GPA Report (University of Canterbury)

      Use this link only (also provided below) to enter the Scholaro website as entering from elsewhere will not create the report in the New Zealand 9 point scale. Click "Get Started" to create a Scholaro account or "Sign In" if you already have an ...

    • Ordering a GPA Report (University of Waikato)

      Go to https://www.scholaro.com/apply/waikato Choose “One Report” for calculating the GPA of your highest completed degree, required for your University of Waikato application. Create your account with your email and password Enter payment information ...