Documentation Bookings and calendars Splose

Bookings integration

Splose

Splose integration overview
  • CategoryBookings
  • AuthAPI key

Overview

Splose connects on /integrations in the MessageMind dashboard. Click the Splose card and the "Connect Splose" modal opens with a single masked field, "API key" (placeholder "Paste your Splose API key"), with a reveal toggle and the tooltip "Created by a workspace owner in the Splose dashboard (API keys). Treat it like a password and never share it." The modal description reads "Paste an API key created by a workspace owner in the Splose dashboard. Your services are imported when you connect, and the AI books with the practitioners you allow in the Splose settings." MessageMind sends only that one key on save; the server probes both Splose deployments (Australia and New Zealand, then UK) to find the right region, reads the workspace to prove the key, and stores the discovered region beside the credential. Once connected, the AI reads the clinic's locations, active practitioners and services, checks live free slots, matches or creates a patient record and books Unconfirmed appointments into a practitioner's diary.

What MessageMind can do with it

  • Read the workspace's locations, active practitioners and services across the clinic.
  • Sync bookable services into the MessageMind catalogue daily (Splose publishes no webhooks).
  • Check live free slots for a service at a location on a chosen practitioner's grid, in windows of up to seven days.
  • Match an existing Splose patient by phone or email (both exact match) before creating a new one.
  • Create a new patient record when the clinic has no match for the person messaging.
  • Book one appointment into a live practitioner's diary under a workspace-aware lock, so the same slot is never written twice.

Requirements

  • A Splose workspace with at least one active location, one active practitioner and one bookable service.
  • An API key created by a workspace owner in the Splose dashboard under API keys. The key carries an optional expiry.
  • The workspace must be on the main (Australia and New Zealand) or the UK deployment; a key from one deployment is refused by the other.
  • A Services account kind on the MessageMind side (the sync writes into the services catalogue).

How to connect

  1. In Splose, a workspace owner opens the dashboard, goes to API keys and creates a key. Copy it straight away and treat it like a password.
  2. In the MessageMind dashboard, open /integrations and click the Splose card. The 'Connect Splose' modal opens.
  3. Paste the key into the single 'API key' field (placeholder 'Paste your Splose API key'). The field is masked by default with a reveal toggle.
  4. Click Integrate. A 'Connecting to Splose...' toast appears while MessageMind probes both regions (Australia and New Zealand first, then the UK) by calling GET /me on each host, verifies the key has not expired, and reads the catalogue to confirm there is at least one live location, one active practitioner and one service. The probe can take a while.
  5. On success the toast flips to the connected confirmation and the reveal toggle resets. If the field was empty on save, the modal refuses with the missing-key message; a wrong or expired key surfaces the server's own error message in the toast.

Authentication and permissions

Mechanism
API key sent as a bearer token to api.splose.com/v1 (Australia and New Zealand) or api-uk.splose.com/v1 (UK). No OAuth and no refresh. The region is discovered at connect and stored on the integration.
Credentials
A single API key stored encrypted on the MessageMind tenant, plus the discovered region. The connect form sends exactly one wire key (apiKey); the server finds the region itself.

Available data and actions

Reads

  • The key's owner, the organisation id and the key's expiry via /me.
  • Non-archived locations, practitioners and services across the workspace.
  • Live free slots per service, location and practitioner over a window of up to seven days, in UTC.
  • Patient records by id, and patient searches on exact-match filters such as phone or email (patient data).

Writes

  • New patient records when the clinic has no match for the person messaging.
  • New Unconfirmed appointments on a chosen practitioner, service, location, date and time.

AI agent use cases

  • Offer the soonest free slot for a service at the right clinic location and quote it in the patient's own time zone and the workspace's currency.
  • Pin the request to a specific practitioner the patient named, only offer times that practitioner is actually free, and refuse to invent a different one.
  • Match the patient to an existing Splose record by the chat's own phone or email before creating a new one, so history and billing stay on one card.
  • Confirm the slot back to the patient and only write to the diary once the patient explicitly says yes.

Configuration

  • aiAvailability (default on): the AI may read free slots. Turning this off disables the booking tool too.
  • aiBooking (default on, only effective while aiAvailability is on): the AI may write Unconfirmed appointments.
  • slotIntervalMinutes (default 15): the grid of start times the AI offers.
  • Rate limit: Splose allows 60 calls per minute per key; MessageMind keeps its own per-key budget at 50 so a burst is refused in-thread instead of as a 429.
  • Daily catalogue sync: Splose publishes no webhooks, so services are polled once a day and a no-change pass writes nothing.
  • Calendar binding: Splose sits in the Calender/Meetings category, so the AI books with the practitioners you allow in the Splose settings.

Example workflows

Connect Splose

  1. A workspace owner creates an API key in the Splose dashboard under API keys and copies it.
  2. In /integrations, click the Splose card to open the 'Connect Splose' modal.
  3. Paste the key into the single 'API key' field (masked by default) and click Integrate.
  4. The 'Connecting to Splose...' toast is shown while the server probes Australia and New Zealand, then the UK, calls GET /me, verifies the expiry and reads the workspace.
  5. On success the toast flips to the connected confirmation and the AI begins quoting live slots.

Book an appointment with a practitioner

  1. Patient asks for a service with a specific practitioner.
  2. The AI checks live free slots on that practitioner's grid for the service at a location, in a window of up to seven days.
  3. The AI quotes an opening in the clinic's time zone and the workspace's currency.
  4. Patient confirms. The AI matches them to an existing Splose patient by the chat phone or email, or creates a new patient record.
  5. Under a workspace-aware lock on the practitioner's diary, the AI re-reads the live grid, confirms the slot is still open and writes the appointment as Unconfirmed.

Limitations

  • A Splose workspace lives on exactly one deployment (Australia and New Zealand, or the UK). A key from one is a plain 401 on the other.
  • Splose publishes no webhooks, so service changes are picked up by a daily poll.
  • Free-slot windows are capped at seven days per call; longer windows are cut into six-day chunks aligned on local midnights to survive a daylight-saving change.
  • Services that are packages, group services or NDIS support activities are synced but marked not bookable.
  • Patient search is exact match on phone or email; near-miss shapes of a number are not matched.

Troubleshooting

Submit refuses with the missing-key message.

The 'API key' field was empty on save. Paste the key from the Splose dashboard (API keys) into the single field and click Integrate again.

Connect fails because Splose did not recognise the API key in Australia and New Zealand or in the UK.

Re-generate the key in Splose and copy it whole. A key from one deployment is refused by the other with the same 401, which is why the server probes both before giving up.

Connect fails because the Splose API key has expired.

Splose keys carry an optional expiry. Create a new one in the Splose dashboard under API keys and reconnect.

The AI will not book a specific service.

That service is a package, group service or NDIS support activity, which MessageMind marks not bookable at sync time. Book it manually in Splose or convert it to a bookable appointment service.

The AI books with the wrong practitioner.

The AI books with the practitioners you allow in the Splose settings. Open the Splose settings panel on the integration card and narrow the allowed practitioners to the ones you want the AI to use.

Disconnect and reconnect

  • In the MessageMind dashboard, open /integrations, select Splose and choose Disconnect. The stored API key and region are removed from the tenant.
  • Appointments already written in Splose stay in the practitioner's diary; disconnecting does not cancel them.
  • To reconnect, create a fresh key in Splose under API keys and paste it into the connection form.