Connecting other systems (API keys and webhooks)

What it's for

Most systems can connect to Hally themselves: your website or GoHighLevel can add enquiries and book appointments, and tools like Zapier can hear about new bookings. You set it up in Settings → Integrations; nobody needs to do it for you.

API keys

Under API keys, press Make a key, name it after the system it's for, and tick only what it needs: seeing services and free times, adding enquiries, seeing or booking appointments, and (only if it truly needs them) seeing patients' names and contact details. Copy the key straight away: it's shown once. Paste it where the other system asks for an API key or bearer token, and send whoever sets it up the How to use the API link.

Keeping keys safe

Give each system its own key. If a key might have leaked, or you stop using a system, press Revoke: it stops working at once. Every use of a key is in the access log, and each key can make 120 requests a minute.

Webhooks

Under Webhooks, press Add a webhook, paste the address the other system gave you (it must start https://) and tick the events it should hear about: bookings, cancellations, new patients, accepted treatment plans and payments. Copy the signing secret into the other system so it can check messages really come from you. Send test checks the address works; each webhook shows how its last message went.

Details or ids only

A webhook normally carries only ids (which appointment, which patient), and the other system asks the API for anything else. Tick Include details to send the patient's name and contact with it; only do that for systems you trust with patient data, and list them in your privacy notice.

If a message doesn't arrive

It's tried again after 1 and 5 minutes, half an hour, then 2, 6, 12 and 24 hours, then marked failed. Untick Sending to pause a webhook while the other system is down.