XUND
Reference

Parameters

Every script tag attribute and JS API property of the Health Check App.

HTML attributes are used with the script embed, JS properties with the JS API. A dash means the option is not available in that method.

HTML attributeJS propertyTypeRequiredDescription
client-idclientIdstringyesYour Client Id.
webapp-codewebappCodestringyesYour Web App Code.
auth-codeauthCodestringyesA fresh auth code for each page load — see Authentication.
webapp-base-urlwebappBaseUrlstringyeshttps://frame.health-check.class2.xund.solutions — without it, the Symptom & Illness Check App is loaded.
—targetContainerIdstringyes (JS API)The id of the element the app is rendered into.
—checkIdstringnoOpens an existing check by its id instead of starting a new one.
app-languageappLanguagestringnoThe app's language — see Language.
agecustomization.agenumbernoPrefilled age, 18–100.
gendercustomization.gendermale | femalenoPrefilled gender.
sexcustomization.sexmale | femalenoPrefilled sex.
heightcustomization.heightnumber (cm)noPrefilled height, 50–260.
weightcustomization.weightnumber (kg)noPrefilled weight, 20–500.
risk-topicscustomization.riskTopicscomma-separated string / string[]noRisk topic ids to start with — see Risk topics.
onboardingcustomization.onboardingbooleannoThe onboarding page before the check; on by default, false skips it — see Onboarding.
compact-modecustomization.compactModebooleannoHides the logo and menu in the header — see Compact mode.
—customization.onCheckStartfunctionnoCalled with { checkId } when a check starts — see Events.
—customization.onReportShownfunctionnoCalled with { checkId, reportData } when the report is shown — see Events.
auth-base-urlauthBaseUrlstringnoOnly when XUND gives you a different auth URL. Must be a *.xund.solutions URL; otherwise the default https://login.xund.solutions/api is used.

In HTML attributes, boolean options take the string "true" or "false".

Last updated on