Skip to content
H

Available · Practice Software

Halaxy Integration

Deep integration with real-time webhooks for instant updates

Connect Halaxy to Grounded Scribe and your client portal sees live Halaxy availability before offering slots. Client self-bookings, on rules you set, flow into Halaxy with patient matching, alongside clinical note syncing from the AI Scribe. Webhook-driven updates mean changes in Halaxy are reflected instantly.

What You Can Do

  • Real-Time Availability

    The client portal queries Halaxy for live practitioner availability before offering appointment times.

  • Patient Matching & Creation

    Clients booking through the client portal are matched to existing Halaxy records. New patients can be created automatically when no match is found.

  • Clinical Note Syncing

    Push AI-generated clinical notes from scribe sessions directly into Halaxy patient records.

  • Webhook-Driven Updates

    Changes in Halaxy (cancellations, reschedules, new patients) are pushed to Grounded Scribe in real time via webhooks — so every booking surface always sees up-to-date availability.

How to Connect

  1. Get your Halaxy credentials

    Make sure your Halaxy API add-on is active, then go to Settings > Integrations > External > Create New Key and copy both the Client ID and Client Secret.

    Setup guide

    Grant the key read access to Practitioners, Practitioner Roles, Slots/Availability, Appointments, Organization and Patients, and write access to Appointments and Patients. Clinical notes are never read. To have a note of each call added to the client’s clinical notes (if call notes are switched on), also grant create access to Clinical Notes.

  2. Connect in Grounded Scribe

    Go to Settings > Integrations, select Halaxy, and enter your Client ID and Client Secret.

  3. Configure webhooks (optional)

    For instant updates, paste the webhook URL shown in your Grounded Scribe integration settings into Halaxy under Settings > Integrations > Webhooks. Without webhooks, changes still sync automatically every hour.

  4. Enable the integration

    Activate the Halaxy integration under Settings > Integrations. Your client portal will offer your live Halaxy availability.

Frequently Asked Questions

Is the Halaxy integration free?

The Grounded Scribe side is free on all plans. Halaxy may charge for API access depending on your Halaxy plan — check with Halaxy for details.

What are webhooks and why do they matter?

Webhooks let Halaxy push updates to Grounded Scribe instantly — so if a patient cancels in Halaxy, your client portal immediately shows that slot as open again.

Can I create new patients through the integration?

Yes. When a new client books an appointment through the client portal and no existing patient record is found, Grounded Scribe can create a new patient in Halaxy automatically.

What data does Grounded Scribe access in Halaxy?

Practitioner schedules, appointment types, patient name/DOB/contact for matching, and appointment slots. Optionally, outstanding invoice balances can be read (display only, never modified). Clinical notes are never read. If the practice owner switches call notes on, a note of each call is added to the client’s clinical notes.

Privacy & Security

All integration data is encrypted in transit and at rest. Client health and personal information is stored in Australia, and Grounded Scribe complies with the Australian Privacy Act. We only access the minimum data required for each integration to function.

Ready to Connect Halaxy?

All integrations are included free on every plan. Sign up, connect Halaxy, and let the AI handle the rest.

Need your Halaxy phone answered? Salutant, our AI receptionist, books into Halaxy by your rules.Halaxy AI receptionist →