Skip to main content

​
Overview

This section documents React types and interfaces used with the Headless Web SDK hooks and APIs. Refer to the cards below for more information on each type.

​
Authentication and tokens

UseAuthParams

Parameters for the useAuth hook

LoginResponse

Response shape from the login flow

RegistrationResponse

Response shape from registration

UpdatePartnerTokenResponse

Response from partner token updates

​
Ambient session

SessionContext

Patient, provider, and visit context for sessions

UseAmbientSessionParams

Parameters for useAmbientSession

UseAmbientSessionReturn

Return type of useAmbientSession

AmbientSessionStatus

Session status values and related typing

​
Next steps

Refer to Provider for more information on how to warp your application with the PlatformClient and PlatformClientProvider before using hooks.
Last modified on April 20, 2026