Documentation

Everything you need to get started with iSupplose.

Getting a Splose API key

iSupplose connects to your Splose practice via its REST API. You'll need to generate an API key from the Splose admin panel.

  1. Log in to Splose with an account that has admin/owner permissions.
  2. Navigate to Settings → Integrations → API.
  3. Click Generate new API key.
  4. Give the key a descriptive name (e.g. "iSupplose sync").
  5. Copy the key immediately — it won't be shown again.
  6. In iSupplose, go to Settings and paste the API key into the Splose API key field.
  7. Enter your Splose practice web URL (e.g. https://yourpractice.splose.com).
  8. Click Save.

Your API key is encrypted at rest using a dedicated encryption key stored in Azure Key Vault. It is never exposed in logs or API responses.

iSupplose requires Microsoft 365 permissions to read and write calendar events on behalf of your practitioners. A Global Administrator in your Azure AD tenant must grant consent once.

  1. Sign in to iSupplose with your Microsoft 365 work account.
  2. Navigate to Settings.
  3. In the Microsoft 365 Integration section, click the Grant admin consent link.
  4. You will be redirected to the Microsoft identity platform consent screen.
  5. Review the requested permissions:
    • Calendars.ReadWrite — read and write calendar events for synced practitioners
    • User.Read.All — look up practitioner accounts by email
  6. Click Accept to grant consent for your entire organisation.
  7. You'll be redirected back to iSupplose. The consent status will update to show that permissions have been granted.

Only a Global Administrator or Privileged Role Administrator can grant tenant-wide admin consent. If you're not sure who that is, contact your IT team.

Setting up practitioners and sync

Once your Splose API key and Microsoft 365 consent are configured, you can enable calendar sync for individual practitioners.

Enabling practitioners

  1. Go to the Practitioners panel in iSupplose.
  2. You'll see a list of all practitioners from your Splose practice.
  3. Toggle the Enabled switch for each practitioner you want to sync.
  4. For each enabled practitioner, enter their Microsoft 365 email address so iSupplose knows which Outlook calendar to use.

Practitioners default to disabled. Only enable those who need two-way calendar sync.

How sync works

Microsoft Teams alerts

You can configure a Teams webhook URL in Settings to receive notifications when:

Task automation

In Settings → Task Automation, you can configure automatic task creation:

Provisioning an Azure OpenAI API key

The AI practice assistant uses Azure OpenAI to answer questions about your Splose data. You'll need to create an Azure OpenAI resource and deploy a model.

  1. Go to the Azure Portal and sign in.
  2. Search for Azure OpenAI and click Create.
  3. Choose a subscription, resource group, and region (Australia East recommended for lowest latency).
  4. Give the resource a name and select the Standard S0 pricing tier.
  5. Click Review + Create, then Create.
  6. Once deployed, go to the resource and click Model deployments → Manage Deployments.
  7. Click Create new deployment:
    • Model: gpt-4.1-mini (recommended for cost/performance balance)
    • Deployment name: e.g. gpt-4.1-mini
    • Set a tokens-per-minute rate limit to control costs (e.g. 30K TPM)
  8. Go to Keys and Endpoint in your Azure OpenAI resource.
  9. Copy Key 1 and the Endpoint.
  10. In iSupplose Settings, paste the key, endpoint, and deployment name into the AI assistant configuration fields.

You can set spending limits and alerts in the Azure portal under Cost Management to avoid unexpected charges.

Admin users

Admin users have access to the full iSupplose admin panel, including settings, practitioner management, billing, and sync status.

How admin permissions work

Adding or removing admins

  1. Go to Settings → Admin Users.
  2. To add an admin, type their Microsoft 365 email address and click Add.
  3. To remove an admin, click the Remove button next to their email.

You cannot remove yourself as an admin if you are the only admin remaining.

Using the AI assistant

The AI practice assistant lets you ask questions about your Splose data in plain English. It can look up appointments, clients, practitioners, invoices, and more.

Example prompts

What it can access

The AI assistant can query your Splose practice data in real time, including:

Tips for best results