How to Connect Your AI Receptionist to Halaxy

What the Halaxy Integration Does

The Halaxy integration enables five key capabilities for your AI Receptionist:

1. Real-time availability checking

Your receptionist reads your live Halaxy availability and offers only the appointment types you allow for online booking in Halaxy. Callers are only offered slots that are actually available.

2. Patient matching

Callers are checked by name, date of birth and phone; caller ID is a hint, never proof. Existing patients are matched automatically. When you're taking new clients, a new caller gets a Halaxy patient record with their booking.

3. Appointment booking

Review mode is on by default, so nothing touches your Halaxy diary without your tap: each request waits in To do until you approve it. Switch to Put it straight in the diary and confirmed bookings land the moment the call ends. Salutant books for multi-practitioner Halaxy practices too.

4. Call notes

Switch on Call notes in your practice software (Settings › Integrations) and, about 40 minutes after each call, the call summary is added to the client's clinical notes in Halaxy, as a draft for you to check — only when the client's full name and date of birth match.

5. Updates from Halaxy

Changes you make in Halaxy count straight away: your receptionist reads your live Halaxy availability on every call, and your Salutant Calendar shows your Halaxy diary, read live.

How to Connect Halaxy

Step 1: Generate your Halaxy credentials

First, make sure your Halaxy API add-on is active — the integration won't connect without it. Then:

1. Log in to your Halaxy account
2. Go to Settings → Integrations → External
3. Click Create New Key
4. Name the key (e.g. "Salutant AI Receptionist") and give it read access to Practitioners, Practitioner Roles, Slots, Appointments, Organization and Patients, and write access to Appointments and Patients (and to Document References, for clinical notes, if you switch call notes on)
5. Copy both the Client ID and the Client Secret — Halaxy only shows the secret once

Store these securely. If you lose the Client Secret, you'll need to generate a new key.

Step 2: Add your credentials to Salutant

1. Log in to Salutant
2. During setup, open the Diary step. Once you're live, it's Settings › Integrations, then Connect practice software
3. Choose Halaxy
4. Paste your Client ID and Client Secret into the matching fields
5. Click Connect Halaxy

When it's connected, Salutant shows "Connected to Halaxy" and lists the appointment types callers can book.

Step 3: Keep online bookings on

Online bookings must be switched on in Halaxy for your receptionist to see your free times. The appointment types you allow for online booking in Halaxy are the ones callers can book. To change the list, change it in Halaxy, then press Refresh from Halaxy in the Diary step.

Step 4: Test the integration

Use a free test call in your browser to verify everything works:

1. Open Test call (in setup, or Settings › Receptionist › Test call)
2. Start the call — it uses your microphone
3. Ask about your availability for a specific date
4. Confirm the slots match your Halaxy calendar

A test call uses the same receptionist and diary as a live call, but nothing is booked in your real diary. Test calls are free while you set up, up to 30 minutes a day.

What Syncs and When

Understanding Halaxy API Costs

Halaxy charges for API usage through its own add-on and credit system. Check with Halaxy whether your Halaxy plan charges for the add-on, and what your call volume will use.

Here's what Salutant uses the connection for:

• Availability checks — each incoming call reads your calendar
• Patient lookups — matching callers to existing patients
• Appointment creation — booking into Halaxy
• Call notes — adding call summaries to patient records, if you switch it on

Salutant does not charge any additional fees for the Halaxy integration itself — it's included on every plan.

Pricing

Connecting Halaxy doesn't cost extra on any Salutant plan. The only additional cost is Halaxy's own charge for API use, if your Halaxy plan has one. See Salutant pricing.

Troubleshooting

"Connection failed" error: Make sure your Halaxy API add-on is active, and that you copied the full Client ID and Client Secret with no trailing spaces. Halaxy only displays the secret once — if you've lost it, generate a new key in Settings → Integrations → External.

Availability doesn't match: Check that online bookings are switched on in Halaxy and that the appointment types you want callers to book are allowed online. Then press Refresh from Halaxy in the Diary step.

Notes not appearing: Call notes are added only when the client's full name and date of birth match the Halaxy record, and the key needs write access to Document References. Only the practice owner can switch call notes on.

---

The Halaxy integration gives your AI Receptionist direct access to your practice diary, so callers get accurate availability, existing patients are recognised, and appointments are booked without any manual work.

Get started and connect your Halaxy account in the Diary step.