⚠️ To integrate with Cliniko, you'll need to be on the Practice tier (a 14-day free trial is available). The Cliniko integration is currently only available in Australia. This applies to both Heidi Scribe and Heidi Comms.
Video demo — set up and use Cliniko
Generate your Cliniko API key
You'll generate one API key in Cliniko, then use it to connect Cliniko to Heidi Scribe, Heidi Comms, or both. Follow these steps in Cliniko first, then jump down to the section for whichever side of Heidi you're setting up.
Logga in på ditt Cliniko-konto.
Click the arrow next to your name in the bottom-left corner of the screen.
Click My Info.
Scroll down to the API keys section. Flip the switch labelled "Allow yourself to create and use API keys" to Yes.
Click Update user at the bottom of the page.
Cliniko will ask you to verify your identity with your password or passkey.
Once verified, the page will refresh. Under API-nycklar klickar du på Hantera API-nycklar.
On the API Keys page, click Add an API Key.
Give your API key a name. We recommend "Heidi Health" so you'll recognise it later.
Click Create API Key. You'll see a string of letters and numbers — that's your API key. Copy it now — Cliniko won't show it again. If you miss it, you can always create a new one.
💡 For more on Cliniko API keys, see Cliniko's own help article.
You're now ready to connect Cliniko to Heidi. Pick the relevant section below — or set up both.
Connect Heidi Scribe to Cliniko
With your API key copied, head to Heidi and navigate to Settings → EMR Integrations → Cliniko.
Click Set up Integration and paste in your API key.
Click Connect Integration.
Once connected, you'll see a confirmation screen. If you hit any errors, our support team is here to help.
If you're asked for a Practitioner ID
Some clinicians will be prompted for a Practitioner ID during set-up. To find yours in Cliniko:
Click Settings in the left menu bar.
Open Users & practitioners under "Our clinic".
Välj dig själv.
Click Edit their practitioner settings.
Your Practitioner ID is in the URL, between
/practitioners/and/edit.
Use Heidi Scribe with Cliniko
Open the Sessions panel from the left-hand menu.
In the Sessions panel, select the Schedule tab.
Click the calendar icon to choose a day. Today's sessions are shown by default.
Find the appointment you want and select the patient.
Genomför din konsultation normalt.
Review and edit your note as needed.
When you're ready, click Push note to Cliniko. Heidi will create a new Treatment note in that patient's Cliniko file.
💡 Important: Only patients you open from the Schedule tab will have a "Push to Cliniko" button.
Creating and updating notes
The first time you push a note, Heidi creates a Treatment Note in Cliniko in draft status.
If you push the note again, Heidi will update the existing Treatment Note, as long as it's still in draft.
If the Cliniko Treatment Note has been finalised or archived, pushing again will create a new note instead.
Connect Heidi Comms to Cliniko
Heidi Comms uses the same Cliniko API key you generated above, plus two extra details: your region code and your base URL.
With your API key copied, open Heidi Comms and click into the Integrations tab.
Paste your Cliniko API key into the API key field.
Find your region code. Your API key ends with a short code (like
au1,au4, oruk1) that tells Heidi which Cliniko server your account is on. Look at your key and find the few characters that come after the last hyphen (-) — that's your region code.Enter your base URL. Your base URL is the address Heidi uses to talk to Cliniko. In the next field, paste the URL below and replace
REGIONwith the value you just found:<https://api.REGION.cliniko.com/v1>
So for example, if your region code is
au4, your base URL becomes:<https://api.au4.cliniko.com/v1>
Click Connect to Cliniko. You're all set.
💡 Why does Heidi need a 'region code'? Cliniko hosts different accounts on different servers around the world. The region code (the few characters at the end of your API key) tells Heidi which server your account is on, and the base URL is the complete address that Heidi uses to reach it. If you've seen the word "shard" in Cliniko's developer documentation, that's the same thing — we use "region code" here because it's clearer.
If the connect step fails, double-check that the region code in your base URL matches the very end of your API key exactly, with no extra spaces.
If you run into trouble setting up either integration, please reach out to our support team — we're here to help.