Create an onboarding, send the practice one link, and the office completes setup on its own. Your app gets a callback when it’s done and a status for every step in between. Built for engineers.

A hosted setup flow the office finishes without you, and the signals your app needs to know when the practice is live.
A hosted setup link the office completes
A callback to your app when setup finishes
Status per step, with the error and who has to act when one fails
Data ready and availability ready events
Request access for practices already on NexHealth, with nothing to install
link the office completes
tracked steps, from link opened to complete
installs when the practice already runs NexHealth

“An AI agent that cannot read a live schedule and write a confirmed booking back into the health record system is just an answering machine.”
Zachary Costa, Software developer, Yobi
Read the storyOne call creates the onboarding and returns the link to send. The guide walks through every status after that.
// Create an onboarding and get the link to send the office const res = await fetch('https://nexhealth.info/onboardings', { method: 'POST', headers: { 'Nex-Api-Version': 'v3.1.0', Authorization: `Bearer ${token}`, 'Content-Type': 'application/json' }, body: JSON.stringify({ onboarding: { callback_url: 'https://yourapp.com/nexhealth/done', locations: [{ external_id: 'loc_8f3a1c', name: 'Smile Dental Downtown', street_address: '123 Market St', zip_code: '94105' }] } }) }).then(r => r.json()); res.data.url // send this to the office res.data.status // in_progress, complete or failed// Create an onboarding and get // the link to send the office const res = await fetch( 'https://nexhealth.info' + '/onboardings', { method: 'POST', headers: { 'Nex-Api-Version': 'v3.1.0', Authorization: `Bearer ${token}`, 'Content-Type': 'application/json' }, body: JSON.stringify({ onboarding: { callback_url: 'https://yourapp.com/done', locations: [{ external_id: 'loc_8f3a1c', name: 'Smile Dental', street_address: '123 Market St', zip_code: '94105' }] } }) } ).then(r => r.json()); res.data.url // send this res.data.status // in_progress, // complete, failedimport requests # Create an onboarding and get the link to send the office res = requests.post("https://nexhealth.info/onboardings", headers={"Nex-Api-Version": "v3.1.0", "Authorization": "Bearer " + token}, json={"onboarding": { "callback_url": "https://yourapp.com/nexhealth/done", "locations": [{"external_id": "loc_8f3a1c", "name": "Smile Dental Downtown", "street_address": "123 Market St", "zip_code": "94105"}]}}).json() res["data"]["url"] # send this to the office res["data"]["status"] # in_progress, complete or failedimport requests # Create an onboarding and get # the link to send the office res = requests.post( 'https://nexhealth.info' '/onboardings', headers={ 'Nex-Api-Version': 'v3.1.0', 'Authorization': 'Bearer ' + token}, json={'onboarding': { 'callback_url': 'https://yourapp.com/done', 'locations': [{ 'external_id': 'loc_8f3a1c', 'name': 'Smile Dental', 'street_address': '123 Market St', 'zip_code': '94105'}]}} ).json() res['data']['url'] # send this res['data']['status'] # in_progress, # or complete# Create an onboarding and get the link to send the office curl -s -X POST "https://nexhealth.info/onboardings" \ -H "Nex-Api-Version: v3.1.0" \ -H "Authorization: Bearer $NEX_TOKEN" \ -H "Content-Type: application/json" \ -d '{"onboarding": {"callback_url": "https://yourapp.com/nexhealth/done", "locations": [{"external_id": "loc_8f3a1c", "name": "Smile Dental Downtown", "street_address": "123 Market St", "zip_code": "94105"}]}}' # data.url is the link to send; data.status is in_progress, complete or failed# Create an onboarding and get # the link to send the office API=https://nexhealth.info curl -X POST $API/onboardings \ -H "Nex-Api-Version: v3.1.0" \ -H Content-Type:application/json \ -d '{ "onboarding": { "callback_url": "https://yourapp.com/done", "locations": [{ "external_id": "loc_8f3a1c", "name": "Smile Dental", "street_address": "123 Market St", "zip_code": "94105" }] } }' \ -H "Authorization: Bearer $TOKEN" # data.url is the link to send # data.status: in_progress, # complete or failed
The sandbox is free. Production is $0.10 per API call.