Get started
Standards and APIs

Webhooks and the MedAppz API and MedAppz

Your own systems can book patients in, register them, read bills and stock, and hear about changes through signed webhooks. It works today with scoped API keys your clinic creates in MedAppz.

LiveEverywhere MedAppz is offered
What it does

What happens through Webhooks and the MedAppz API

  • Webhooks fire for registrations, bookings, cancellations, no-shows, finished visits, bills, payments, refunds, admissions, discharges and new leads.
  • Each delivery is signed with HMAC-SHA256 over a timestamp and the body, and retried after 1 minute, 5 minutes, 30 minutes, 2 hours and 8 hours.
  • Narrow keys find slots and book, move or cancel a patient’s appointment, or register a patient through the desk’s own duplicate check.
  • Feeds for bills and payments, and for pharmacy stock and waiting prescriptions, carry ids, names of medicines and amounts, not clinical notes.
  • An OpenAPI document with TypeScript and Python clients, and a sandbox clinic to build against.
Switching it on

What it takes

  1. Step 1Create an API key with only the scopes the system needs. Keys last a year by default and two years at most.
  2. Step 2Add a webhook subscription with your HTTPS address and choose the events.
  3. Step 3Check the signature on every delivery, and expect the odd repeat.
  4. Step 4Build against the sandbox clinic first.

What it does not do yet

Notes and prescriptions are never put in a webhook; a subscriber reads details with its key. A webhook address must be on the public internet; internal addresses are refused.
In the store

The apps that use Webhooks and the MedAppz API

Each carries its status from the catalog.

API Keys · live in clinicsFHIR Link · live in clinicsEnquiries & Leads · live in clinicsOnline Booking · live in clinics
Questions

Asked about this connection

Does MedAppz connect to Webhooks and the MedAppz API?
Yes. It works on medappz.com today. Your own systems can book patients in, register them, read bills and stock, and hear about changes through signed webhooks. It works today with scoped API keys your clinic creates in MedAppz.
How do I switch on Webhooks and the MedAppz API?
Create an API key with only the scopes the system needs. Keys last a year by default and two years at most. Add a webhook subscription with your HTTPS address and choose the events. Check the signature on every delivery, and expect the odd repeat. Build against the sandbox clinic first.
What does the Webhooks and the MedAppz API connection not do yet?
Notes and prescriptions are never put in a webhook; a subscriber reads details with its key. A webhook address must be on the public internet; internal addresses are refused.
Related

Read next