API and webhooks
Build your integrations with DappleOS.
For aesthetic and cosmetic clinics.
Build custom connections with first-class access to the DappleOS GraphQL API. Create scoped API access for your integration and use webhooks to connect supported clinic events with the systems your team relies on.
Build around your clinic
Your systems. Connected to your clinic workflow.
Bring the data your external systems need into a defined integration, reducing the manual exports and repeated hand-offs in that workflow. Start with our existing connections, then build where your clinic needs something specific.
Explore existing integrationsFirst-class GraphQL access
Use supported queries and mutations through the platform’s GraphQL API.
Scope each connection
Select a user, brands and permissions for a named API key.
Connect clinic events
Send supported events to the receiving system you configure.
A starting point for developers
Download the schema and build against the available operations.
GraphQL API
Work directly with your clinic data.
Query the fields your integration needs and use supported mutations for actions. First-class access works through DappleOS’s GraphQL API and permission model, with access determined by your credentials and relevant feature entitlements.
- Patients
- Connect patient records with the external workflows your clinic has authorised.
- Appointments
- Work with appointment information and supported booking operations.
- Invoices
- Connect billing records with your finance and business workflows.
- Product catalogue
- Query product details for the systems you build around your clinic.
- Clinical records
- Access permitted clinical information for an agreed integration workflow.
- Prescriptions
- Work with supported prescription data, subject to the relevant permissions.
Scoped access
Give each connection its own access.
Create a named key for the integration you are building. Select its user, brands and permissions so the connection has a defined place in your clinic’s access model.
When the connection is no longer needed, remove the key to make it inactive. Your developer should validate the permissions against the intended workflow.
API key scopes and webhook subscriptions are separate settings. A webhook does not inherit the key’s selected permissions or brands.
Webhooks
Let clinic events start the next step.
Alongside request-based API access, webhooks send supported event notifications to your configured URL. Your receiving system handles the external workflow, from an invoice hand-off to an appointment update.
- 01 A supported clinic event
- 02 Your webhook endpoint
- 03 Your external workflow
Supported event families
- Appointments
- Appointment status changes
- Patients
- Form submissions
- Invoices
- Memberships
- Clinical notes
- Payments
- Prescriptions
- Treatment plans
Developer handoff
From an idea to a working connection.
Bring your use case and your developer or integration partner. We can discuss the access and events available for the workflow you want to build.
- 01
Start with your workflow
Identify the systems, data and actions you want to connect. Check the integrations directory for an existing connection first.
- 02
Add API and webhook access
Discuss the paid add-on and your integration requirements with the DappleOS team.
- 03
Create scoped credentials
Choose a named API key, its user, brand access and permissions for the work your integration needs to do.
- 04
Give your developer the schema
Download the API schema from DappleOS settings so your developer can inspect the available queries, mutations and types.
- 05
Configure the relevant webhooks
Choose supported event types and the receiving URLs for your external system. Webhooks are configured separately from API keys.
- 06
Build and validate the connection
Your developer implements the external workflow, checks permissions and data handling, and tests the connection before relying on it.
Trust and compliance
Keep your clinic in control of each connection.
Set the access your integration needs and manage its credentials and webhook subscriptions from DappleOS.
Feature availability depends on your plan, enabled features and access permissions.
- Hosted in Australia
- Encrypted storage
- Named, scoped access
- Create API keys with a selected user, brands and permissions. Access remains subject to the platform’s permission model and relevant feature entitlements.
- Revocable credentials
- Remove a key when a connection is no longer needed. The key becomes inactive so it can no longer authenticate API requests.
- Clinic administration
- API and webhook settings are managed through authorised clinic administration access.
- Separate webhook controls
- Configure event types and destination URLs separately. Webhook payloads do not inherit an API key’s selected scopes.
FAQs
Can we connect our own systems to DappleOS?
Yes. The GraphQL API and webhooks support custom connections for aesthetic and cosmetic clinics. Your developer or integration partner builds the external connection around the supported operations, permissions and events your workflow needs. Check our integrations directory first to see whether a suitable connection already exists.
Is API and webhook access included in my plan?
API and webhook access is available as a paid add-on to DappleOS plans. Book a demo to discuss access for your clinic and the integration you want to build.
What can we access through the GraphQL API?
Supported areas include patients, appointments, invoices, product catalogue information, clinical records and prescriptions. Your developer can use the downloadable schema to inspect the available queries and mutations. Access depends on the selected permissions, user and brands, as well as applicable feature entitlements.
Can we limit what an integration can access?
Yes. Create a named API key with a selected user, brands and permissions, and remove the key when it is no longer needed. Your developer should validate that the selected access supports the intended workflow. Webhook configuration is separate from API key scopes.
How do webhooks work alongside the API?
The GraphQL API lets your integration request data and perform supported actions. Webhooks send notifications for supported clinic events to a configured receiving URL, where your external system handles the next step. DappleOS settings show the webhook type, status, URL and error information.
Do we need a developer to build a custom integration?
Yes. A developer or technical integration partner needs to implement and maintain your custom connection, including authentication, data handling and the receiving workflow for webhooks. The DappleOS team can discuss the supported access and events for your proposed use case.
How can our developer get started?
Start with a demo to discuss the integration and paid add-on. Once access is arranged, an authorised clinic administrator can create scoped credentials, download the GraphQL schema and configure relevant webhooks. Your developer then builds and validates the connection against your clinic’s requirements.
Ask DappleOS
Ask how the connected DappleOS workflow could fit your clinic, or book a demo for a guided review.
