# Newsroom and Sentral Data Integration ## How the Integration Works PortalHQ connects to Sentral through the Sentral REST API, using an API key and tenant the school configures in Sentral. Each night, PortalHQ retrieves current students, their parents and carers, and staff from Sentral. Newsroom by PortalHQ then refreshes its contact lists from that data, so families and staff who join or leave Sentral 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 boarders, or all staff at one campus), and those lists remain current as Sentral records change. | Step | Frequency | What happens | |---|---|---| | Sentral to PortalHQ | Nightly, around 10:10 pm AEST (11:10 pm during daylight saving) | Current students, parents and carers, and staff are read from Sentral and updated in PortalHQ. | | PortalHQ to Newsroom by PortalHQ contacts | Nightly | Newsroom by PortalHQ contacts and dynamic mailing lists are refreshed from the synced records. Families and staff who have left are removed. | ## Current Families (Parents and Carers) Parents and carers are drawn from each student's contacts in Sentral (Enrolments API, student-contact). A contact is brought in when their relationship to the student is Parent, Step-Parent, Father, Step-Father, Mother, Step-Mother or Guardian. Other relationships, such as grandparents or emergency-only contacts, are not included by default, but extra relationship types can be added for a school on request. Each parent's personal details are then read from their Sentral person record (Enrolments API, person, including their email addresses). Only parents linked to at least one current student are included. When a family's last child leaves the school, that family is removed from the current parent audience automatically. ##### Fields retrieved for each parent or carer | PortalHQ field | Source in Sentral | Notes | |---|---|---| | First name | Person: firstName | | | Surname | Person: lastName | | | Email address | Person: email. If that is blank, the person's email address marked Primary, otherwise their first listed email address. | A parent with no email address in Sentral is not added as a Newsroom by PortalHQ contact. | | Relationship | Student contact: relationName | For example Mother, Father or Guardian. | | Lives with student | Student contact: livesWith | Set when the parent lives with at least one of their children. | | Deceased | Person: isDeceased | A deceased parent is never added as a contact. | | Do not contact | Student contact: doNotContact | When this is ticked on every one of the parent's student links, the parent is kept unsubscribed in Newsroom by PortalHQ. | | Mobile number | Core families: contact1Mobile / contact2Mobile, matched to the parent by email address | Held on the parent's PortalHQ record. Newsroom by PortalHQ email does not use it. | ##### Fields inherited from their children (for targeting) | PortalHQ field | Source | |---|---| | Year level(s) | Each current child's year group | | House(s) | Each current child's house | | Campus(es) | Each current child's campus | | Form class(es) | Each current child's roll class | | Boarding parent | Whether any current child is a boarder | | Student flags | Sentral enrolment flags on any current child | ## Current Students Students are drawn from Sentral enrolments (Enrolments API, enrolment) with a status of Active or Active (leaving) in the current academic year. Each student's details are then read from their Sentral student and person records. Students enrolled for a future start date are not brought in until their enrolment starts. Students whose year group is recorded in Sentral as Foundation are not currently brought in. | PortalHQ field | Source in Sentral | |---|---| | First name | Person: firstName | | Surname | Person: lastName | | Email address | Person: email (students with no email address are not added as Newsroom by PortalHQ contacts) | | Student ID | Student record ID | | Year level | Enrolment: schoolYear | | House | Enrolment: house (name from the Sentral house list) | | Form class | Enrolment: roll class (name from the Sentral roll class list) | | Campus | Enrolment: campus | | Boarder | Enrolment: isBoarding | | Gender | Person: genderCode (male or female) | | Student flags | Student: flags (names from the Sentral enrolment flag list) | Schools that record parent email addresses on student records in Sentral can ask for student emails to be ignored, so parents keep their own addresses. ## Staff Staff details are drawn from the Sentral staff list (Core API, core-staff, and Enrolments API, staff), with personal details read from each staff member's Sentral person record. A staff member is included when they are active in Sentral, their employment status is permanent, permanent part-time, temporary full-time or temporary part-time, and they have a current employment record at the school. Casual staff and staff whose employment has ended are not included. Individual staff members can also be excluded from Newsroom by PortalHQ in PortalHQ. | PortalHQ field | Source in Sentral | |---|---| | First name | Person: firstName | | Surname | Person: lastName | | Email address | Core staff: email. If that is blank, person: email. Staff with no email address are not added as Newsroom by PortalHQ contacts. | | Staff ID | Staff record ID | | Position | Staff: jobTitle | | Campus | Staff employment: campus locations | ## Alumni Alumni are not retrieved from Sentral 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 Sentral. It never writes contact details back to Sentral. - Parents marked Do Not Contact in Sentral on all of their student links are kept unsubscribed in Newsroom by PortalHQ. Removing the flag later does not re-subscribe them automatically. - Contacts who unsubscribe in Newsroom by PortalHQ remain unsubscribed. A subsequent sync does not re-subscribe them. - 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](mailto:support@teamhq.com.au) or +61 2 8387 7321.