Getting started
The Mayotte Hub API lets a company that works with our clinics, for example a booking or POS system, talk to us over HTTPS. Version 1 answers two things: it checks your key, and it takes the events your system sends us.
- Address:
https://api.mayottehub.com/v1/ - Format: JSON in, JSON out, UTF-8.
What you get
Section titled “What you get”Mayotte Hub gives you, once:
- a key,
mh_live_…, which you send with every call; - a signing secret,
mh_whsec_…, if your key may send events.
Keep both on your server, never in an app or a web page. We cannot show them again. If one is lost or leaks, ask for a new key; the old one is revoked.
1. Check the address
Section titled “1. Check the address”GET /v1/health needs no key. It tells you the API is reachable.
curl https://api.mayottehub.com/v1/health{ "ok": true, "service": "Mayotte Hub API", "version": 1, "time": "2026-11-11T12:00:00.000Z" }2. Check your key
Section titled “2. Check your key”GET /v1/ping answers with the company your key belongs to.
curl https://api.mayottehub.com/v1/ping -H "Authorization: Bearer $MAYOTTE_KEY"{ "ok": true, "partner": "Your company", "scopes": ["ping", "webhooks"], "time": "2026-11-11T12:00:00.000Z" }If you get an error instead, its code says why: see Errors.
- Keys and limits: how keys, addresses and limits work.
- Sending events: sign and send your first event.