v10

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-21162658.7 KB

partner

Create Launch Session

Create a report-writing launch session for a clinician in the connected practice. Requires an Idempotency-Key header: retrying with the same key and identical body returns the original session; reusing a key with a different body fails with 409. Sessions expire 48 hours after creation if not completed. Open the returned launch_url for the clinician.

post/v1/partner/launch-sessions

Headers

Idempotency-Keystring required

Unique key per logical session (for example a UUID). Enables safe retries.

Request body

external_client_idstring required

Your platform's ID for the client. Used to remember the client mapping across sessions on this connection.

clinician_emailstring required

Must match the verified email of exactly one member of the connected practice. Matching is case-insensitive.

client_first_namestring nullable

Shown to the clinician when mapping the client for the first time.

client_last_namestring nullable

Shown to the clinician when mapping the client for the first time.

Example request

{
  "external_client_id": "your-client-42",
  "clinician_email": "jordan@examplepractice.com",
  "client_first_name": "Alex",
  "client_last_name": "Nguyen"
}

Response

Session created (or the existing session for a repeated Idempotency-Key).

session_idstring required

status'created' | 'opened' | 'completed' | 'expired' required

launch_urlstring required

Open this URL for the assigned clinician to write the report in Everbility.

expires_atstring date-time required

Sessions expire 48 hours after creation if not completed.

Example response

{
  "session_id": "psess_Zl9nB1qFhOQe2kQ4rW8xJ3Ty",
  "status": "created",
  "launch_url": "https://www.everbility.com/partner-sessions/psess_Zl9nB1qFhOQe2kQ4rW8xJ3Ty",
  "expires_at": "2026-07-08T04:15:00Z"
}