Give time back to your team
Automate repetitive administration and data entry, so clinicians and operational teams can spend less time copying records and more time with patients.
Developer Platform v1
Build powerful and secure healthcare integrations on Carebit’s Developer Platform.
Connect systems that your organisation operates to Carebit with our secure JSON API and signed webhooks. Build private integrations for your organisation’s own use.
You can use AI agents as part of a private integration that your organisation deploys, controls and operates. Do not give custom-integration credentials to third-party products. Reviewed third-party products will use the Carebit App Store authorization process when it becomes available.
Make Carebit work your way
Turn your Carebit data into better ways of working
Automate repetitive work, connect systems that your organisation operates, and create private experiences tailored to your patients and clinicians.
Make workflows your own
Combine API actions and real-time events with your own logic. Fully customise the way your practice runs and build bespoke experiences.
Build on your Carebit data
Turn your existing patient and clinical data into custom apps, dashboards, portals, calendars, and tools designed around your organisation.
Connect the patient journey
Keep bookings, patient details, letters, and results moving securely between Carebit and systems that your organisation controls.
Learn the platform
Guides
Introduction
Getting started
Create a developer project, mint a credential, set up webhooks, exchange it for an access token, and make your first request.
Introduction
Authentication
OAuth2 client credentials and refresh tokens, plus how to revoke a token or rotate a credential.
Testing
Testing your integration
Create a safe example patient, send fabricated webhook events, and verify your integration without using real patient data.
API
Pagination and filtering
Cursor pagination, page sizes, and how to filter list endpoints.
API
Idempotency and retries
Required Idempotency-Key on every POST create and PATCH update. Replays return the stored response.
API
Validation errors
Error response envelope, HTTP status meanings, and how to correlate a support ticket.
API
Rate limits
Per-token, per-project, per-Organization, and per-IP limits applied at the Cloudflare edge.
API
Creating and connecting Patients
How POST /v1/patients creates a Patient, reuses a connected match, or opens a PatientConnectionRequest that your organisation explicitly acts on.
API
File uploads and imports
Upload Base64 file bytes or import files from public URLs, then track asynchronous validation and malware scanning.
Webhooks
Webhook setup
Register an HTTPS endpoint, subscribe to events, and receive signed deliveries.
Webhooks
Webhook signatures
Verify Carebit webhook signatures with a constant-time HMAC-SHA256 compare across every active v1 digest.
Webhooks
Webhook retries
How the dispatcher retries a failed delivery, when it gives up, and how manual resend works.
Support
Support diagnostics
Attach a request id, correlate a webhook delivery, and share the minimum context we need to help.
Conventions
Changelog and versioning
Path-versioned. Additive-only inside a major version. Deprecations announced in advance.
Marketing & analytics
Google Tag Manager
Load your GTM container on the Patient Portal booking flow and fire a conversion when a booking is confirmed.
Complete reference
API endpoints
113 endpoints across 35 resource groups, each with copyable cURL, JavaScript, Python, Ruby, and PHP examples.
Browse the full reference- post
/oauth/revoke - post
/oauth/token - get
/v1/alternative_payors - get
/v1/alternative_payors/:id - post
/v1/availability_periods - patch
/v1/availability_periods/:id - delete
/v1/availability_periods/:id - get
/v1/availability_slots - get
/v1/booking_forms - post
/v1/booking_forms - get
/v1/booking_forms/:id - patch
/v1/booking_forms/:id - get
/v1/bookings - post
/v1/bookings - get
/v1/bookings/:id - patch
/v1/bookings/:id - post
/v1/bookings/:id/cancellations - get
/v1/clinician_agenda - get
/v1/clinicians - get
/v1/clinicians/:id - get
/v1/credit_notes - post
/v1/credit_notes - get
/v1/credit_notes/:id - patch
/v1/credit_notes/:id - delete
/v1/credit_notes/:id - get
/v1/digital_form_responses - post
/v1/digital_form_responses - get
/v1/digital_form_responses/:id - get
/v1/digital_forms - post
/v1/digital_forms - get
/v1/digital_forms/:id - get
/v1/expirable_files - get
/v1/expirable_files/:id - get
/v1/human_tasks - post
/v1/human_tasks - get
/v1/human_tasks/:id - patch
/v1/human_tasks/:id - post
/v1/human_tasks/:id/comments - get
/v1/insurance_companies - get
/v1/insurance_companies/:id - get
/v1/invoices - post
/v1/invoices - get
/v1/invoices/:id - get
/v1/lead_form_responses - get
/v1/lead_form_responses/:id - get
/v1/lead_pipelines - get
/v1/leads - post
/v1/leads - get
/v1/leads/:id - patch
/v1/leads/:id - post
/v1/letter_batches - get
/v1/letters - post
/v1/letters - get
/v1/letters/:id - get
/v1/lists - post
/v1/lists - get
/v1/lists/:id - patch
/v1/lists/:id - delete
/v1/lists/:id - get
/v1/lists/:list_id/members - post
/v1/lists/:list_id/members - delete
/v1/lists/:list_id/members/:id - get
/v1/locations - get
/v1/locations/:id - get
/v1/next_availability_slot - get
/v1/notes - post
/v1/notes - get
/v1/notes/:id - patch
/v1/notes/:id - get
/v1/organization - get
/v1/organizations - get
/v1/patient_connection_requests - get
/v1/patient_connection_requests/:id - post
/v1/patient_connection_requests/:id/actions - get
/v1/patients - post
/v1/patients - get
/v1/patients/:id - patch
/v1/patients/:id - get
/v1/patients/:id/payment_methods - get
/v1/patients/:patient_id/connections - post
/v1/patients/:patient_id/connections - get
/v1/patients/:patient_id/connections/:id - patch
/v1/patients/:patient_id/connections/:id - get
/v1/patients/:patient_id/payors - post
/v1/patients/:patient_id/payors - get
/v1/patients/:patient_id/payors/:id - patch
/v1/patients/:patient_id/payors/:id - get
/v1/payments - post
/v1/payments - post
/v1/payments/:id/refunds - get
/v1/photos - post
/v1/photos - get
/v1/photos/:id - patch
/v1/photos/:id - post
/v1/quotes - get
/v1/recall_programmes - get
/v1/recall_programmes/:id - get
/v1/remote_file_import_batches/:id - post
/v1/reports - post
/v1/service_variants - patch
/v1/service_variants/:id - get
/v1/services - post
/v1/services - get
/v1/services/:id - patch
/v1/services/:id - get
/v1/staff_members - get
/v1/staff_members/:id - post
/v1/test_result_batches - get
/v1/test_results - post
/v1/test_results - get
/v1/test_results/:id - get
/v1/token - get
/v1/transmissions
Real-time updates
Webhook events
Keep your integration synchronized with signed, retryable events.
booking.arrivedbooking.canceledbooking.confirmedbooking.did_not_attendbooking.end_time_reachedbooking.updateddigital_form_response.completedexpirable_file.availableinvoice.finalizedinvoice.overdueinvoice.paidinvoice.sentinvoice.settledlead.converted_to_patientlead.createdlead.form_response_submittedlead.stage_changedlead.updatedlist.member_addedlist.member_removedpatient_connection.createdpatient_connection_request.createdpatient_connection_request.deniedpatient_connection_request.expiredpatient_connection_request.grantedpayment.paidquote.acceptedquote.createdrefund.createdrefund.failed