Docs

Doc Menu
Main Menu

Benefits

View All Benefits

FEATURES

View All Features

SIS INTEGRATIONS

View SIS Integrations

FINANCE INTEGRATIONS

View Finance Integrations
Main Menu

Documentation

View All Docs

Help Centre

View Help Centre

EVENTS

View All Events

Learn

View All Learn
Main Menu

Company

Data

Want a personalised product tour?

Our team of experts would love to show you around.

Request a Demo
Main Menu

Pricing

EnrolHQ to Compass Integration

Compass is a widely used Student Management System in the Australian K-12 market.

Integration Overview

The EnrolHQ to Compass integration runs a one-way sync of enrolment data from EnrolHQ into Compass. Once a family completes the application and orientation process in EnrolHQ, a single button press creates their record in Compass.

The integration creates the student record and associated parent/guardian records in Compass. It also carries across the supporting enrolment data captured in EnrolHQ - medical conditions, doctor details, emergency contacts, sibling details and prior school history. Document sync (uploading PDFs to Compass) is not supported by this integration.

Under the hood, the sync calls the Compass Enrolments API (the /Enrolments/V1/import endpoint) and authenticates with an API-key header supplied by the school.

How to Set Up

To connect EnrolHQ to a Compass instance, the school's Compass administrator creates a dedicated API user and provides EnrolHQ with the following four items:

  1. URL: the Compass API base URL, must end in /API
  2. Username: the API user account (for example, EHQAPI)
  3. Password: provided to EnrolHQ securely
  4. API Secret: a UUID-format key used to authenticate each request
Once EnrolHQ receives these credentials, it runs a proof-of-connection test against a single test student to confirm the connection is live and the field mappings are correct. EnrolHQ then schedules a short demonstration meeting with the school before running any bulk sync.

Mappings

  • Campus Codes: matches each EnrolHQ campus to its Compass campus by name (not required for single-campus schools)
  • Year Levels: matches each EnrolHQ year level to its Compass year level code
  • Gender Values: Male, Female and Other mapped to their Compass numeric codes
  • Indigenous / Ethnicity Types: maps to their Compass Indigenous-type values
  • Residential Status: Permanent Resident, Temporary and Citizen maps to their Compass codes
  • Relationship Types: Mother, Father, Guardian and other parent-to-student relationships maps to their Compass codes
  • Medication Permissions: maps so medical and consent data lands in the correct Compass fields

Syncing from EnrolHQ

Pressing Sync to Compass on EnrolHQ runs the following:

  • Student Profile: builds the student record and map core details (name, date of birth, gender, indigenous type, residential status). If a date of birth is missing, a default of 1971-01-01 is used
  • Commencement Date Resolution: determines the student's start date in priority order:
      • (1) the student's commencement date field if explicitly set;
      (2) commencement-date settings matched by entry year and grade;
      (3) term-based defaults (T1 -> 1 Jan, T2 -> 1 Apr, T3 -> 1 Jul, T4 -> 1 Oct);
      (4) a fallback of 1 Jan in the entry year.
  • Parent/Guardian Sync: for each parent, creates the parent record, sets the adult-to-student relationship, and maps occupation, education background and contact details
  • Supporting Data: attaches medical conditions, doctor details, emergency contacts, sibling details and prior school history to the student record
  • Delivery: sends the assembled payload to Compass. A single-student sync sends one student plus their parents in one call. A bulk sync processes students sequentially with a 10-second delay between each to stay within Compass rate limits

Last reviewed: