Skip to main content

Connect Arlo to Nookal

Written by Dmytro

Overview

Arlo integrates with Nookal so you can:

  • Sync appointments from your Nookal location(s)

  • Open a consultation, record, and generate a clinical note

  • Push the treatment note back to Nookal

You can keep Cliniko and Nookal configured at the same time, but only one can be active. The active system is what Arlo uses for appointments and note export.

Before you start

You will need:

  1. An Arlo account (signed in)

  2. Admin access to your Nookal practice

  3. An API V3.0 OAuth Client in Nookal (see below)

Important: Arlo requires a Nookal API V3.0 OAuth client and its Basic Key.
Older / non–V3.0 API keys will not work with Arlo.

Treat the Basic Key like a password. Do not share it in chat, email screenshots, or public docs.

Step 1 — Create an API V3.0 OAuth client in Nookal

In Nookal, create (or edit) an API OAuth Client for Arlo.

Required settings

Configure the client exactly as follows. If Locations, Queries, or Mutations are incomplete or incorrect, Arlo will not work properly (locations may fail to load, appointments may not sync, or notes may fail to push).

Setting

Required value

API version

API V3.0 (must be V3.0 — not an older API key type)

Client note

e.g. Arlo (so you can identify it later)

Locations

Select every location you want to use from Arlo

Queries

Clinical Notes, Locations, Appointments

Mutations

Clinical Notes, Appointments

Status

Active

Queries (must all be selected)

  • Clinical Notes — needed to read treatment notes / previous notes

  • Locations — needed so Arlo can list and select your clinic locations

  • Appointments — needed to sync appointments into Arlo

Mutations (must all be selected)

  • Clinical Notes — needed to push / write treatment notes from Arlo back to Nookal

  • Appointments — needed for appointment-related write actions used by the integration

Locations

In the Locations field, select each Nookal location Arlo should access.
Only selected locations will appear in Arlo. If you add a new clinic location later, edit this OAuth client and include it, then re-save in Arlo.

Save and copy the Basic Key

  1. Click Save.

  2. When Nookal shows the Basic Key, copy it immediately and store it securely.

  3. Nookal typically only reveals the Basic Key once (“The client 'Basic Key' has already been revealed”). If you lose it, create a new OAuth client (or regenerate per Nookal’s process) and update Arlo.

When pasting into Arlo:

  • Paste the Basic Key exactly

  • Do not add the word Basic in front of it

  • Avoid extra spaces or line breaks

Step 2 — Open Integrations in Arlo

  1. Sign in to Arlo.

  2. Go to Integrations
    (URL path: /integrations)

You’ll see cards for Cliniko and Nookal.

Step 3 — Connect Nookal in Arlo

  1. In the Nookal card, paste your key into GraphQL Basic Key (for OAuth).

  2. Wait a few seconds while Arlo:

    • Authenticates with Nookal

    • Discovers your region automatically

    • Loads your locations

  3. Open the Location dropdown and select the location you want Arlo to use.

  4. Click Save Nookal.

  5. Confirm the status badge shows Ready.

If the location list stays empty or you see an authentication error, go back to Step 1 and confirm the OAuth client is API V3.0, Active, and has the correct Locations / Queries / Mutations.

Step 4 — Make Nookal the active integration

Saving credentials is not enough — Arlo must be told to use Nookal.

  1. On the same Integrations page, click Use Nookal.

  2. You should see confirmation that the active integration is set to Nookal.

  3. The Nookal card should show as Active.

You can switch back to Cliniko later with Use Cliniko (if Cliniko is also configured).

Step 5 — Confirm it works

  1. Go to Appointments.

  2. Check that the page shows Nookal as the active integration.

  3. Select your location (if prompted) and a date range.

  4. You should see appointments from Nookal for that location.

If the list is empty on a busy day, confirm:

  • The location is selected in Arlo

  • That location was included on the Nookal OAuth client

  • Appointments exist in Nookal for that date/location

Optional — Import Nookal note templates

Once Nookal is active:

  1. Go to Prompts / Templates in Arlo.

  2. Use the option to import templates from your active integration (Nookal).

  3. Select the Nookal treatment note templates you want and import them into Arlo.

This helps Arlo generate notes in a format that matches how your clinic writes notes in Nookal.

Everyday workflow (after setup)

  1. Open Appointments and pick today’s Nookal appointment.

  2. Start the consultation in Arlo (record as usual).

  3. Generate the treatment note.

  4. Review/edit the note.

  5. Push it to Nookal using Add to Nookal / final save actions on the session.

Completing the loop means the note is saved back into Nookal, not only generated inside Arlo.

Note: Some Cliniko-only extras (for example PDF upload for letters/summaries) may not apply when Nookal is active. Treatment note push to Nookal is the primary path.

Switching between Cliniko and Nookal

  • You may store credentials for both systems.

  • Only one is active at a time.

  • To switch: Integrations → Use Nookal or Use Cliniko.

  • After switching, refresh Appointments to confirm the correct system is listed.

Changing location or rotating the key

Change location in Arlo

  1. Go to Integrations.

  2. Select a different Location.

  3. Click Save Nookal.

Add a new clinic location

  1. In Nookal, edit the Arlo API V3.0 OAuth Client.

  2. Add the new location under Locations.

  3. Save in Nookal.

  4. In Arlo, re-open Integrations, refresh/reload locations, select the new location, and Save Nookal.

Replace / rotate the Basic Key

  1. Create a new API V3.0 OAuth client in Nookal (same Queries, Mutations, Locations, Status = Active).

  2. Copy the new Basic Key.

  3. Paste it into Arlo → GraphQL Basic Key (for OAuth).

  4. Wait for locations to reload, re-select location if needed, then Save Nookal.

  5. Disable the old OAuth client in Nookal.

Troubleshooting

Symptom

What to try

Locations don’t load / auth error

Confirm the key is from an API V3.0 OAuth client. Re-copy the Basic Key exactly (no Basic prefix).

Key accepted but locations empty / missing

Edit the OAuth client and ensure the correct Locations are selected.

Appointments don’t sync

Confirm Queries → Appointments is selected and Status is Active.

Can see appointments but can’t push notes

Confirm Mutations → Clinical Notes is selected.

Previous notes / templates fail

Confirm Queries → Clinical Notes is selected.

“Invalid client” / OAuth rejected

Wrong key, expired client, or Status not Active. Create/fix a V3.0 client and paste the new Basic Key.

Appointments still show Cliniko

Click Use Nookal on Integrations, then reopen Appointments.

Still stuck

Sign out/in, re-check V3.0 permissions against the table above, then contact Arlo support with clinic name, approximate time, and the error message (do not send the full Basic Key).

Quick permissions checklist (copy/paste)

On the Nookal API OAuth Client for Arlo, verify:

  • API V3.0

  • Status = Active

  • Locations = all clinics you need in Arlo

  • Queries = Clinical Notes + Locations + Appointments

  • Mutations = Clinical Notes + Appointments

  • Basic Key pasted into Arlo → Save Nookal → Use Nookal

Missing any of these will cause Arlo to fail or behave inconsistently.

Security & privacy

  • Store the Basic Key only in Arlo’s Integrations screen (encrypted server-side).

  • Use a dedicated OAuth client named Arlo.

  • Disable unused clients in Nookal.

  • Limit who in your practice can access Nookal API OAuth Client settings.

Did this answer your question?