# Newsroom and Synergetic Data Integration ## How the Integration Works PortalHQ connects to Synergetic through the Synergetic API Portal (the apiportal/v1 endpoints), using API client credentials the school configures in Synergetic. Each night, PortalHQ retrieves current students, their parents and carers, and staff from Synergetic. Newsroom by PortalHQ then refreshes its contact lists from that data, so families and staff who join or leave Synergetic 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 Synergetic records change. | Step | Frequency | What happens | |---|---|---| | Synergetic to PortalHQ: students, families and staff | Nightly, around 9:30pm AEST (10:30pm during daylight saving) | Current students, parents and carers, and staff are read from Synergetic and updated in PortalHQ. Campuses are refreshed straight afterwards. Where PortalHQ serves several Synergetic schools, each school's run starts a few minutes after the last. | | Synergetic to PortalHQ: household addresses | Daily, around 5:30am AEST (6:30am during daylight saving) | Home and postal addresses for each family are read from the student contact records. These are kept in PortalHQ but are not used for Newsroom by PortalHQ targeting. | | 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 found through each current student's contact records in Synergetic (endpoint studentcontact), and their personal details are then read from their Synergetic community record (endpoint community). Each student contact record can name a spouse (ContactSpouseID), so both partners are included when the record lists them. A contact record is treated as a parent or carer only when all of the following are true: - Its contact type (ContactType) is SC1, SC2, SC3 or SC9. - The contact is set to receive reports (ReportsFlag). - The contact is set to receive normal mail (NormalMailFlag) or lives with the student (LivesWithFlag). - The relationship (ContactRelationshipDescription) is a parent, step-parent, guardian or carer type. Mother, Father, Step Mother, Step Father, Parent, Guardian and Carer are kept as they are. Wider family such as grandparents, aunts, uncles and siblings are grouped as Guardian, and arrangements such as homestay, agents and family friends are grouped as Carer. Unrecognised relationship types are not included. 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 Synergetic | Notes | |---|---|---| | Title | Community record: Title | | | First name | Community record: Given1 | | | Preferred name | Community record: Preferred | Stored in PortalHQ. Newsroom by PortalHQ contacts use the first name. | | Surname | Community record: Surname | | | Email address | Community record: Email, or OccupEmail when Email is blank | Parents without an email address are not added as contacts. Where two parents share one email address, only one contact is created for that address. | | Mobile phone | Community record: MobilePhoneActual | | | Relationship | Student contact: ContactRelationshipDescription (or ContactSpouseRelationshipDescription for the named spouse) | Grouped as described above. | | Is parent | Student contact: ParentFlag | | | Lives with student | Student contact: LivesWithFlag | Set when the parent lives with any of their current children. | | Do not contact | Student contact: NormalMailFlag | If normal mail is turned off on any of the parent's contact records, the parent is marked do not contact and is kept unsubscribed in Newsroom by PortalHQ. See Privacy and Preferences below. | ##### 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 | | Campus(es) | Each current child's campus | | Form class(es) | Each current child's form class | | Boarding parent | Whether any current child is a boarder | ## Current Students Student details are drawn from the Synergetic student record (endpoint student). A student is treated as current when their active flag (StudentActiveFlag) is set. Students who are no longer active are removed from Newsroom by PortalHQ. | PortalHQ field | Source in Synergetic | |---|---| | Student ID | ID | | Title | StudentPersonalInfo: Title | | First name | StudentPersonalInfo: Given1 | | Preferred name | StudentPersonalInfo: Preferred (stored in PortalHQ; Newsroom by PortalHQ contacts use the first name) | | Surname | StudentPersonalInfo: Surname | | Gender | StudentPersonalInfo: Gender | | Email address | StudentOccupEmail (students without an email address are not added as contacts) | | Year level | StudentYearLevelDescription | | House | StudentHouseDescription | | Form class | StudentFormDescription. Schools that use tutor groups instead can have this read from StudentTutor. | | Boarder | StudentBoarderSynergyMeaning (a student is a boarder when this contains BOARDER) | | Campus | The student's campus listing in Synergetic (endpoint student/campus), with campus names from the Synergetic campus lookup table (luCampus) | | Current student | StudentActiveFlag | ## Staff Staff details are drawn from the Synergetic staff record (endpoint staff). A staff member is included when their active flag (ActiveFlag) is set and they hold a current job position in Synergetic (JobPositions, with a start date in the past, no end date in the past, and the position marked active). For schools that do not record job positions in Synergetic, PortalHQ can be set to rely on the active flag alone. Staff without an email address are skipped, and PortalHQ can optionally be limited to staff with an email address on the school's own domain. Staff records marked as contractors in Synergetic (the word Contractor in VoiceMail, with an email address outside the school's domain), such as parent volunteer coaches, are given contractor access in PortalHQ and are not added to the staff audience. | PortalHQ field | Source in Synergetic | |---|---| | Staff ID | ID | | Title | Title | | First name | Given1 | | Preferred name | Preferred (stored in PortalHQ; Newsroom by PortalHQ contacts use the first name) | | Surname | Surname | | Email address | OccupEmail, or Email when OccupEmail is blank | | Mobile phone | MobilePhone | | Position | CategoryDescription | | Campus | StaffCampus | | Staff code | SchoolStaffCode (stored in PortalHQ, not used for Newsroom by PortalHQ targeting) | | Department | DepartmentDescription (stored in PortalHQ, not used for Newsroom by PortalHQ targeting) | ## Alumni Alumni are not retrieved from Synergetic 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 spreadsheet columns use Synergetic's own field names, so an export from Synergetic can be used with little or no reformatting. 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 | Given1 | | Surname | Surname | | Email address | Email (rows without an email are skipped) | | Class Of | PeerYear | | Is Alumni | Set automatically on import | ## Privacy and Preferences - Newsroom by PortalHQ only reads contact data from Synergetic. It never writes contact details back to Synergetic. - Contacts who unsubscribe in Newsroom by PortalHQ remain unsubscribed. A subsequent sync does not re-subscribe them. - Synergetic's normal mail setting is respected. If normal mail (NormalMailFlag) is turned off for a parent on any of their children's contact records, Newsroom by PortalHQ marks that parent unsubscribed at every refresh, and they cannot be re-subscribed in Newsroom by PortalHQ while the setting stays off. - Turning normal mail back on in Synergetic does not re-subscribe the parent automatically. Once the setting is back on, the school can re-subscribe them in Newsroom by PortalHQ. - 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.