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 attribute | JS property | Type | Required | Description |
|---|---|---|---|---|
client-id | clientId | string | yes | Your Client Id. |
webapp-code | webappCode | string | yes | Your Web App Code. |
auth-code | authCode | string | yes | A fresh auth code for each page load — see Authentication. |
webapp-base-url | webappBaseUrl | string | yes | https://frame.health-check.class2.xund.solutions — without it, the Symptom & Illness Check App is loaded. |
| — | targetContainerId | string | yes (JS API) | The id of the element the app is rendered into. |
| — | checkId | string | no | Opens an existing check by its id instead of starting a new one. |
app-language | appLanguage | string | no | The app's language — see Language. |
age | customization.age | number | no | Prefilled age, 18–100. |
gender | customization.gender | male | female | no | Prefilled gender. |
sex | customization.sex | male | female | no | Prefilled sex. |
height | customization.height | number (cm) | no | Prefilled height, 50–260. |
weight | customization.weight | number (kg) | no | Prefilled weight, 20–500. |
risk-topics | customization.riskTopics | comma-separated string / string[] | no | Risk topic ids to start with — see Risk topics. |
onboarding | customization.onboarding | boolean | no | The onboarding page before the check; on by default, false skips it — see Onboarding. |
compact-mode | customization.compactMode | boolean | no | Hides the logo and menu in the header — see Compact mode. |
| — | customization.onCheckStart | function | no | Called with { checkId } when a check starts — see Events. |
| — | customization.onReportShown | function | no | Called with { checkId, reportData } when the report is shown — see Events. |
auth-base-url | authBaseUrl | string | no | Only 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