Introduction
Embed the Health Check App in your website or app.
The Health Check App is a pre-built app that embeds XUND's Health Check into your website or mobile app. The app shows the whole check itself, from the first question to the report, so you don't build any check screens.
Two ways to embed
| Script embed | JS API | |
|---|---|---|
| How you add it | One <script> tag with attributes | Load the script, then call XUND.hc.init({...}) |
| JavaScript needed | No | Yes, a few lines |
| Language, profile data, risk topics, onboarding, compact mode | Yes | Yes |
| React when a check starts | No | Yes |
| Read the report data in your page | No | Yes |
Use the script embed for the quickest start. Both ways offer the same customization; choose the JS API when your page has to react to the check.
What you need
- Your Client Id, Web App Code, and API key — XUND provides them during onboarding.
- An auth code, created on your server for every page load — see Authentication.
- A container element with a defined height on your page — the app fills it.
Where to go next
- Authentication — create the auth code the app needs.
- Script embed — embed the app with a single script tag.
- JS API — initialize the app from your own script and react to events.
- Customization — language, profile data, risk topics, onboarding, and compact mode.
- Parameters — every attribute and property in one table.
- Example apps — runnable projects on GitHub that create the auth code and embed the app.
Last updated on