Initiate provider authentication

Initiate authentication for a user. After this request, the user can be redirected to Upheal Video Call experience and is able to use the session token from response to authenticate with Upheal.

application/json

Request Body required

Auth initiation request

providerUserId string required
User id of the provider that will start the session.
clientUserIds string[] required
Client user ids that the provider wants to have a session with.
partnerAppointmentId string
Optional identifier that will be included in the web-hook payload. Can be used to correlate upheal session with partner's identifier.
subjectUserId string
Id of user to initiate the authentication for. Must be either the provider or client user specified in this request. Defaults to the providerUserId

Responses

application/json

Schema
Example (from schema)

Schema

meetingUrl string required
url to use when navigating to Upheal Video Call experience. The url has format https://{uphealAppDomain}/video/{meetingId}?sessionToken=abcd

{
  "meetingUrl": "string"
}

Initiate provider authentication​

Initiate provider authentication