Clinic resources · Connect · Halaxy
Halaxy · Setup guideConnect Halaxy to Zelix Labs
Create a Halaxy API key with only the patient, practitioner and appointment permissions the booking system needs.
Prefer us to set it up with you?See the two ways to set it upWhat an API key is
How Halaxy limits access
Halaxy lets you choose permissions for each key, such as patients, practitioners, appointments and clinical notes. You tick only what booking needs.
API access is a Halaxy add-on that must be activated and uses Halaxy credits. Your Halaxy account must be fully verified, and the person creating the key needs the API Key Manager permission.
Steps
-
Activate the API add-on
If it isn't active yet, activate API access in Halaxy. Check the credit cost with Halaxy before you do.
-
Create a new key
Go to Settings > Integrations, open the External tab and click Create new key. Name it
Zelix Labs booking.For region, choose Default unless your practice is in Europe or the UK.
-
Choose permissions
Tick Patients, Practitioners and Appointments only. Leave Clinical Notes and every other permission unticked.
-
Copy the Client ID and Client Secret
Halaxy shows the Client Secret only when the key is created and can't show it again. Copy both values before you leave the screen. If one is lost, delete the key and create a new one.
-
Send us the key
Send the key to us through the one-time link your project lead gives you. Please don't send keys by email or chat message: the one-time link can be opened once and then stops working.
Leave these off
| Access | Why we don't need it |
|---|---|
| Clinical Notes | Booking never needs clinical records. |
| Invoices, payments and other permissions | Not part of the standard setup. If a project needs more, your project lead will agree it with you first. |
What we keep
Every patient record is cut down to name, phone and status the moment it reaches our system. Everything else, including date of birth, address, email, notes and medical alerts, is discarded before any other part of the system sees it.
On top of the limits you set here, our code carries its own fixed list of allowed actions, so a request for anything else is refused before it leaves our system. Read the full clinic security standard.
Sources
Checked against Halaxy's help documentation on 25 Oct 2026. Halaxy sometimes moves menus between releases. If your screens differ, contact your project lead and we'll go through it with you. These steps come from an integration partner's guide; we confirm them with you during onboarding.