Developer settings
Directory Sync, API keys, and service health — the technical setup tools.
You are a school admin with the developer role, and you handle the technical plumbing — connecting Microsoft 365 so staff and students stay in sync, issuing keys so your school website can send enquiries into the Hub, and keeping an eye on whether the system is healthy. These tools live together under one section of the sidebar. This guide walks you through all three.
Before you start
These pages require the Software Developer role. If you don't see the Development group at the bottom of the left sidebar, ask a school admin to grant it. The Development group holds three items: Service Health, Directory Sync, and API Keys.
Step 1: Connect Directory Sync
In the left sidebar, open the Development group and click Directory Sync. This page keeps your staff and student directory in step with Microsoft 365.
The first time you visit, you'll see Not Synced Yet. Click Subscribe to start syncing users from Microsoft 365. Once connected, each connection appears as a Microsoft Graph Subscription card showing its status (Active or Expired) and an Expiration date.
Subscriptions expire
Microsoft connections have an expiry date. Use the Refresh button (top right) to re-check status. To remove a connection, click the delete icon on its card and confirm Delete this subscription? — this only stops new notifications; staff and students already synced stay put.
Step 2: Create an API key
In the Development group, click API Keys. A key lets a school website's enquiry form post enquiries straight into the Hub. The page lists every key, when it was last used, and whether it's Active or Revoked.
To make a new one, click Create key (top right). In the Create API key panel, type a Name you'll recognise — for example Main website — then click Create key.
Step 3: Copy the key right away
The panel now reads Copy your API key and shows the key once. Click the copy icon to copy it, then click Done.
Shown only once
This is the only time the full key is shown. Copy it now — you won't be able to see it again. If you lose it, you'll need to create a new one.
After this, the list only shows a short hint of the key, never the whole thing.
Step 4: Revoke or delete a key
Each key in the list has two actions:
- Revoke — switches the key off immediately. Any website using it stops working. Use this when a key is no longer trusted but you want to keep its record. This cannot be undone.
- Delete — removes the key from your list entirely. Prefer Revoke if you only want to disable a key while keeping its history.
Both ask you to confirm before they take effect.
Step 5: Check Service Health
In the Development group, click Service Health to see whether the system is running smoothly. The top line reads either All systems operational or Some services are experiencing issues.
Below that, four cards show the parts of the system — Database, Worker, Audit Service, and Server — each marked Operational (green) or Degraded. This is a read-only view; there are no buttons to press, just a quick way to confirm everything is up.
What happens next
- Once Directory Sync is subscribed, staff and student records flow in from Microsoft 365 and refresh automatically.
- A new API key appears in your list as Active and your school website can begin sending enquiries — which show up under Inbounds → Inquiries.
- Service Health gives you an at-a-glance answer when someone asks "is the system down?"
Keep keys tidy
Issue one key per website or integration and give each a clear name. That way, if one needs revoking, you know exactly which site it belongs to.