How the Integration Works
PortalHQ connects to Edumate through the official Edumate Integrations API, using an API client ID and secret the school configures in Edumate. Each morning, PortalHQ retrieves current students, their parents and carers, and staff from Edumate. Newsroom by PortalHQ then refreshes its contact lists from that data, so families and staff who join or leave Edumate flow through to mailing lists automatically, with no manual uploads required.
Audiences can be built from any of the fields listed below (for example, all parents of Year 7 students, or all students in a particular house), and those lists remain current as Edumate records change.
| Step | Frequency | What happens |
|---|---|---|
| Edumate to PortalHQ | Daily, from around 5:45am AEST (6:45am during daylight saving) | Current students, parents and carers, and staff are read from Edumate and updated in PortalHQ. Where several schools are on Edumate, each school’s sync starts a few minutes apart. |
| PortalHQ to Newsroom by PortalHQ contacts | Daily | Newsroom by PortalHQ contacts and dynamic mailing lists are refreshed from the synced records. Families, students and staff who have left are removed. |
Current Families (Parents and Carers)
Parent and carer details are drawn from the Edumate carer contact records (current contacts endpoint, /contacts/contacts/current, with contact type “carer”). Each carer’s relationships in Edumate are used to link them to their children in PortalHQ.
A carer is brought across only when all of the following are true:
- They have an email address in Edumate.
- They are not marked as deceased.
- They have a carer number in Edumate.
- At least one of their relationships is Child, Step Child, Foster Child or Charge, and that relationship has the Mail flag ticked.
Only parents linked to at least one current student are included in Newsroom by PortalHQ. When a family’s last child leaves, or a carer no longer meets the rules above, they are removed from the current-parent audience automatically.
Fields retrieved for each parent or carer
| PortalHQ field | Source in Edumate | Notes |
|---|---|---|
| First name | General info: firstname | |
| Last name | General info: surname | |
| Email address | General info: email_address | Where the field holds more than one address separated by commas, the first address is used. Carers without an email address are not added. |
| Phone | General info: mobile_phone | |
| Do not contact | General info: do_not_contact_flag | A carer flagged Do Not Contact is kept unsubscribed in Newsroom by PortalHQ. |
| Deceased | General info: deceased_flag | A deceased carer is never added as a contact. |
| Linked children | Relationships: relationship_type and the related contact’s student number | Child, Step Child, Foster Child and Charge relationships link the carer to that student. |
| Eligible for mailing | Relationships: mail_flag | At least one child relationship must have the Mail flag ticked for the carer to be included. |
Fields inherited from their children (for targeting)
| PortalHQ field | Source |
|---|---|
| Year level(s) | Each current child’s year level |
| House(s) | Each current child’s house |
| Form class(es) | Each current child’s form class |
Current Students
Students are drawn from two Edumate sources. The student list comes from the current contacts endpoint (/contacts/contacts/current, with contact type “student”). PortalHQ then reads each student’s detail record (/contacts/contact-details/student/{student number}) for their enrolment, house and form class.
A student is included only when their Edumate student status is “Current Enrolment” and their enrolment end date has not yet passed. Students enrolled for a future start are not brought across until Edumate shows them as a current enrolment. Students without an email address in Edumate are still synced into PortalHQ, but are not added as Newsroom by PortalHQ contacts.
| PortalHQ field | Source in Edumate | Notes |
|---|---|---|
| Student number | General info: contact reference, student_number | Students without a student number are skipped. |
| First name | General info: firstname | |
| Last name | General info: surname | |
| Email address | General info: email_address | Where the field holds more than one address separated by commas, the first address is used. |
| Gender | General info: gender | Female, Male, or Other for anything else. |
| Year level | Student detail: enrolment, current_govt_year_level | Shown as K where the form class name contains “Kindergarten”, and as Prep where the form class name does not contain “Year”. |
| Form class | Student detail: enrolment, current_form_run | |
| House | Student detail: general info, house | |
| Current student | Student detail: student_status and enrolment end_date | Status must be “Current Enrolment” with an end date after today. |
Staff
Staff details are drawn from the Edumate staff contact records (current contacts endpoint, /contacts/contacts/current, with contact type “staff”). Where a staff member also appears in Edumate’s teacher list (/lms/teachers, current teachers), their school email address from that list is used instead of the contact email.
Staff without a staff number or without an email address are not brought across. Staff marked inactive in Edumate, or who no longer appear in Edumate, are removed from the current-staff audience.
| PortalHQ field | Source in Edumate | Notes |
|---|---|---|
| Staff number | General info: contact reference, staff_number | |
| First name | General info: firstname | |
| Last name | General info: surname | |
| Email address | Teacher list: school_email_address, otherwise general info: email_address | |
| Phone | General info: mobile_phone | |
| Active | General info: active_flag | Inactive staff are not included in Newsroom by PortalHQ. |
Alumni
Alumni are not retrieved from Edumate by the automatic sync, which reads current students, families and staff only. Instead, alumni are loaded into Newsroom by PortalHQ from a spreadsheet export, and each contact is tagged as alumni with a Class Of year so that cohorts can be targeted (for example, a Class of 2016 reunion). The import can be repeated whenever the school’s alumni records are updated.
Schools that maintain alumni records in another system, such as a CRM or foundation database, can also push contacts into Newsroom by PortalHQ through the PortalHQ API.
| Newsroom by PortalHQ field | Spreadsheet column |
|---|---|
| First name | Given name |
| Surname | Surname |
| Email address | Email (rows without an email are skipped) |
| Class Of | Graduating year |
| Is Alumni | Set automatically on import |
Privacy and Preferences
- Newsroom by PortalHQ only reads contact data from Edumate. It never writes contact details back to Edumate.
- Contacts who unsubscribe in Newsroom by PortalHQ remain unsubscribed. A subsequent sync does not re-subscribe them.
- Carers flagged Do Not Contact in Edumate are kept unsubscribed in Newsroom by PortalHQ. Removing the flag in Edumate later does not re-subscribe them automatically.
- Carers are only included when the Mail flag is ticked on at least one of their child relationships in Edumate. Unticking it on every child relationship removes them from Newsroom by PortalHQ at the next sync.
- Every email sent from Newsroom by PortalHQ includes an unsubscribe link.
Enquiries
For any queries regarding this integration, please contact TeamHQ at support@teamhq.com.au or +61 2 8387 7321.