Connect Cliniko

A step-by-step guide with pictures, from the Speakvora agent's own Connect tab.

Short answer: This connects your own Cliniko account to your Speakvora agent. Then a customer can text where is order 1234 and get the answer in seconds, and the agent can send status and tracking texts. The agent only reads. It can never create, change or delete anything in Cliniko. Only the status word and the order number are.

Every key, number and name in the pictures is a made-up example. Nothing here asks you to share a real key with anyone but the app on your own computer.

This connects your own Cliniko account to your Speakvora agent. Then a customer can text *where is order 1234* and get the answer in seconds, and the agent can send status and tracking texts. The agent only reads. It can never create, change or delete anything in Cliniko. Only the status word and the order number are ever texted back, never names, prices, items or addresses.

TIP: You need about 15 minutes, a computer, and the sign-in for your Cliniko account (the owner or a manager). You can't break anything: if a step does not work, nothing has changed and you can just try again. The keys and screens below are made-up examples.

NOTE: This guide was written from Cliniko's public developer documentation (the addresses and sign-in style were read there) and has not been tried yet on a live Cliniko account. If a screen looks different from what is described, press Connect, then Download report, and send it to support. We fix it for everyone.

Who this is for: healthcare. How Cliniko gives access: You create the key yourself in your own account; no approval is needed. What it costs you: The API docs do not state a plan requirement or extra cost.

Part 1. Get your key from Cliniko

Do this on your computer, in a new browser tab, signed in to Cliniko.

  1. Sign in to Cliniko as the account owner or a user who can see appointments.
  2. Click My Info in the bottom-left navigation.
  3. Click Manage API keys.
  4. Create a new key, name it Speakvora, and copy it straight away because it is shown only once.
  5. Note the region code at the end of the key (for example au2); a key with no ending is au1.
  6. Paste the region code and the key into Speakvora and press Test connection.
  7. To check one booking, give Speakvora the appointment number from the appointment's address in Cliniko.

WARNING: If Cliniko asks which permissions to give, tick only the read-only ones: Use a Cliniko user whose role can see appointments; the key has that user's permissions and cannot be limited to read-only. Speakvora only sends GET requests.. Never give write or admin access.

TIP: To copy the key, click inside the box that shows it, press Command + C on a Mac or Ctrl + C on Windows (or right-click and choose Copy). Nothing will look different. It is now in your clipboard, ready to paste. Keep it private: anyone who has it can read your orders.

Part 2. Open the Connect tab in your agent

  1. Open your agent's dashboard (the page you open from the Start Speakvora Agent file).
  2. Press Connect in the menu. On a phone the menu is the bar along the top; slide it sideways if you do not see Connect.
  3. Step 1: press Connect (1)

  4. Under Your apps type Cliniko in the box that says Find an app (1), or scroll down the list.
  5. Step 2: the Find an app box (1)

  6. Press Cliniko. A card slides up. (If you only see apps for your own kind of business, that is on purpose: your agent only shows the systems that make sense for it.)
  7. Step 3: an app's card. The Full Guide button (1) opens this page.

Part 3. Paste it in

2 boxes to fill in. Click inside a box, press Command + V on a Mac or Ctrl + V on Windows, then move to the next:

  1. Cliniko region code. The last part of your API key after the final hyphen, for example au2 or uk1. A key with no ending is au1.
  2. Cliniko API key (secret: it stays on this computer and is never shown again, only the last few characters). My Info, then Manage API keys. It is shown only once and carries the permissions of the Cliniko user who created it.
  3. Part 3: each numbered box is one thing to paste. These are made-up examples.

TIP: Pasted by mistake into the wrong box? Click the box, press Command + A (Ctrl + A on Windows) to select all, then paste again.

Part 4. Test it

  1. Press the orange Save and test button.
  2. Cliniko is asked for one harmless record, just to prove the key works. Nothing is changed in Cliniko.
  3. Part 4: the green message under the buttons means it worked (1)

YOU SHOULD SEE: green words starting with Connected.

WARNING: Red words mean it did not work yet. Read them, then see If something is wrong below. Nothing bad happened.

What happens next

  • A customer texts something like where is order 1234. The agent answers *Your order 1234 is preparing.* (the status word from Cliniko), or *I could not find that order. A team member will check and reply.*
  • Each person can ask five times an hour. If Cliniko is down, the conversation carries on and the problem is written to Activity.
  • Mode: the agent asks Cliniko when a customer asks.

If something is wrong

  • It says the key was refused (401 or 403): copy the key again from Cliniko. Make sure there is no space before or after it, and that it is a live key for the right shop or location.
  • It cannot find an order (404): the number is not in Cliniko, or Cliniko uses a longer number than the one on the receipt.
  • It says too many requests (429): wait a minute and press Save and test again.
  • Cliniko says you need a plan or approval: Cliniko keys cannot be limited to read-only; Speakvora only reads. The appointment record has no single status word: cancelled_at is empty for an active booking and holds a date when cancelled. Some accounts must enable API key creation first.
  • Still stuck? Press Connect, then Download report, and email it to support. It never contains keys or customer messages.

If your plan has no API

  • Forward appointment confirmation emails to Speakvora

Cliniko's own instructions: https://docs.api.cliniko.com/

All help guides · Every agent feature · AI receptionist by industry

Questions

What if this happens: It says the key was refused (401 or 403)?

copy the key again from Cliniko. Make sure there is no space before or after it, and that it is a live key for the right shop or location.

What if this happens: It cannot find an order (404)?

the number is not in Cliniko, or Cliniko uses a longer number than the one on the receipt.

What if this happens: It says too many requests (429)?

wait a minute and press Save and test again.

What if this happens: Cliniko says you need a plan or approval?

Cliniko keys cannot be limited to read-only; Speakvora only reads. The appointment record has no single status word: cancelled_at is empty for an active booking and holds a date when cancelled. Some accounts must enable API key creation first.

What if this happens: Still stuck??

Press Connect, then Download report, and email it to support. It never contains keys or customer messages.