Home Integrations Edge integration

Edge integration

By mario· May 27, 2026 · Integrations

Edge is a K-12 SIS used by schools in New Zealand. PortalHQ’s Edge integration provides SIS data sync for New Zealand schools using PortalHQ.

What PortalHQ reads from Edge

  • Students — name, year level, gender, date of birth, status.
  • Parents and caregivers — name, email, phone, relationship.
  • Staff — name, email, role.
  • Classes and courses — class lists, teachers.
  • Timetables — periods, rooms.
  • Terms and calendar — NZ school terms.
  • Year groups (Year 0 through Year 13) — NZ year-level structure.

What PortalHQ writes back to Edge

The Edge integration is primarily one-way. Write-back capability is limited. Talk to your PortalHQ rep about current options.

How the sync runs

Sync Frequency
Full sync Overnight (daily)
Delta sync Hourly

Setting up the integration

  1. Confirm your Edge version supports the API.
  2. Generate API credentials via your Edge admin.
  3. Share credentials with PortalHQ through the support channel.
  4. PortalHQ configures the connector and runs a test sync.
  5. Validate the test data, then enable the schedule.

Edge-specific notes

  • Year-group naming — New Zealand uses Year 0 through Year 13. PortalHQ supports the NZ system natively.
  • Caregivers vs. parents — Edge uses caregiver terminology. PortalHQ maps caregivers to parent records internally so existing PortalHQ workflows work without changes.
  • Term structure — NZ schools use 4-term years like Australia but with different dates. PortalHQ imports Edge’s term dates directly.

Common issues

Issue Likely cause Fix
API authentication fails Credentials expired Regenerate in Edge.
Some students missing Enrolment status filter Update filter to include relevant statuses.
Year-group labels wrong Custom Edge labels Adjust mapping in integration settings.

Monitoring

The integrations dashboard shows the daily sync status. A healthy Edge integration runs nightly without errors.

Migration

PortalHQ can migrate to/from Edge by mapping IDs at cutover. NZ schools moving between SIS systems should plan the cutover with their PortalHQ rep and Edge support.