Widget & Dashboard Integration
How UPTIQ Business Health widgets and the Business Health Dashboard authenticate your users via SSO — compare Component Auth and Get Token to pick the right approach.
UPTIQ Business Health brings business health insights into your own platform in two ways:
- Widgets — individual components (Accounts, Credit Score, Cash Flow Forecast, and others) embedded directly into your pages.
- Business Health Dashboard — the full dashboard experience, embedded as an iframe.
In order to show a specific user's data in Business Health, both approaches require a signed-in session for that user. This section explains how Business Health authenticates your users via Single Sign-On (SSO), so they never have to create or remember a separate Business Health password.
Domain Whitelisting RequiredEmbedding individual widgets and/or the iframe Dashboard requires your domain(s) to be whitelisted with Business Health beforehand. Provide UPTIQ with the domain(s) you'll be embedding from as part of your integration setup.
Two Ways to Set Up SSO
Your backend calls Business Health directly, using a signed request, before the page loads. Works for widgets and the full Business Health Dashboard — the recommended starting point for most integrations.
The widget kicks off SSO itself, using auth parameters already on the page. You implement an endpoint Business Health calls back to verify the user. Widgets only, no request signing.
| Get Token | Component Auth | |
|---|---|---|
| Works for | Widgets and the full Dashboard | Widgets only |
| Who initiates the handshake | Your backend, before the page loads | The widget itself, from the browser |
| What you build | A signed API call your backend makes to Business Health | An endpoint Business Health calls to verify the user and return their details |
| Request signing | HMAC-SHA-256 | None |
| Best fit when... | You want your backend to fully control the handshake, or you're embedding the full Dashboard | You want the widget to trigger SSO on its own, using auth parameters already available on the page |
Both approaches produce the same result: a Business Health access token (JWT) that widgets and the Dashboard use to communicate with Business Health on the user's behalf, and both create or update the user's Business Health account from the same underlying data — see SSO Payload for that shared schema.
Flow Diagram
flowchart TD
A[User logs in to<br/>User Platform] --> B{SSO handshake}
B -->|Get Token| D[Backend-initiated —<br/>see Get Token Flow]
B -->|Component Auth| C[Widget-initiated —<br/>see Component Auth Flow]
D --> E[Business Health creates/updates<br/>User & Company, issues JWT]
C --> E
E --> F[Widgets and/or Dashboard render,<br/>using the JWT]
F -.optional.-> G[User Platform Data:<br/>Business Health pulls data directly<br/>from the User Platform]
F -.optional.-> H[Third-Party App Data:<br/>user connects an external app<br/>via the App Connector widget]
style G stroke-dasharray: 5 5
style H stroke-dasharray: 5 5Updated about 4 hours ago