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.
- Log in to Splose with an account that has admin/owner permissions.
- Navigate to Settings → Integrations → API.
- Click Generate new API key.
- Give the key a descriptive name (e.g. "iSupplose sync").
- Copy the key immediately — it won't be shown again.
- In iSupplose, go to Settings and paste the API key into the Splose API key field.
- Enter your Splose practice web URL (e.g.
https://yourpractice.splose.com). - 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.
Granting admin consent in Azure
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.
- Sign in to iSupplose with your Microsoft 365 work account.
- Navigate to Settings.
- In the Microsoft 365 Integration section, click the Grant admin consent link.
- You will be redirected to the Microsoft identity platform consent screen.
- Review the requested permissions:
- Calendars.ReadWrite — read and write calendar events for synced practitioners
- User.Read.All — look up practitioner accounts by email
- Click Accept to grant consent for your entire organisation.
- 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
- Go to the Practitioners panel in iSupplose.
- You'll see a list of all practitioners from your Splose practice.
- Toggle the Enabled switch for each practitioner you want to sync.
- 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
- Splose → Outlook: Every 5 minutes, iSupplose polls Splose for new or updated appointments and creates/updates matching Outlook events.
- Outlook → Splose: When an event is moved or rescheduled in Outlook, a webhook notification triggers an update back to Splose in real time.
Microsoft Teams alerts
You can configure a Teams webhook URL in Settings to receive notifications when:
- New client forms are completed
- Invoices become overdue
Task automation
In Settings → Task Automation, you can configure automatic task creation:
- Form completion tasks: When a client completes a form in Splose, a follow-up task is automatically created.
- Overdue invoice tasks: When an invoice becomes overdue, a task is created to follow up.
- Set lead times and default assignees for each task type.
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.
- Go to the Azure Portal and sign in.
- Search for Azure OpenAI and click Create.
- Choose a subscription, resource group, and region (Australia East recommended for lowest latency).
- Give the resource a name and select the Standard S0 pricing tier.
- Click Review + Create, then Create.
- Once deployed, go to the resource and click Model deployments → Manage Deployments.
- 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)
- Go to Keys and Endpoint in your Azure OpenAI resource.
- Copy Key 1 and the Endpoint.
- 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
- The first user to sign up for a practice is automatically an admin.
- Admin permissions are based on email address. Any Microsoft 365 user whose email is in the admin list can access the admin panel.
- Non-admin users can still access the dashboard, tasks, and AI assistant, but cannot change settings or manage practitioners.
Adding or removing admins
- Go to Settings → Admin Users.
- To add an admin, type their Microsoft 365 email address and click Add.
- 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
- "When is Alison's next appointment?"
- "Show me all appointments for next week"
- "Which clients have overdue invoices?"
- "How many appointments does Dr Smith have today?"
- "What forms has John completed this month?"
- "List clients with upcoming case plan reviews"
What it can access
The AI assistant can query your Splose practice data in real time, including:
- Appointments (past, present, and future)
- Client details and case information
- Practitioner schedules
- Invoices and payment status
- Forms and document completion
Tips for best results
- Be specific with names and dates — "appointments for Sarah next Tuesday" works better than "upcoming stuff".
- You can ask follow-up questions in the same conversation.
- The assistant knows the current date and your practice timezone.
- If a query returns too many results, try narrowing it with a date range or specific practitioner.