Create a session
POST /v1/partner/launch-sessions with a required Idempotency-Key header:
Response
Idempotency. Retrying with the same
Idempotency-Key and identical body returns the original session instead of creating a duplicate. Reusing a key with a different body fails with 409 Idempotency-Key conflict. Use a fresh UUID per logical session.Hand off to the clinician
Openlaunch_url for the clinician — as a link, button, or embedded browser view from your platform. From there, Everbility takes over:
1
Sign in
The clinician signs in with their own Everbility account. Only the clinician matched by
clinician_email can open the session. The launch link does not create a restricted Everbility account: the clinician retains their ordinary Everbility permissions.2
Map the client (first time only)
If this
external_client_id has not been seen before on this connection, the clinician links it to an Everbility client or creates a new one. The mapping is remembered, so later sessions for the same client skip this step.3
Choose and complete
The clinician creates a new report or selects an existing report for the mapped client, then chooses Send to [partner]. A report belonging to another client cannot be sent through the session.
Poll session status
Response
Use webhooks for normal status updates. Polling remains available as a recovery mechanism or when a user views the record in your platform.
Retrieve the completed document
Oncestatus is completed, fetch the rendered report:
Response
format=markdown (default) or format=html. The document stays available on the completed session, so you can re-fetch it after the 48-hour session window.
document_url is relative to https://api.everbility.com. Fetch it with a current OAuth access token. The webhook secret verifies notifications only; it does not authorize API requests.Errors
Errors use the standard shape: