- Dashboard embedding: Embed a dashboard as a read-only, interactive view in an iframe.
- Full app embedding: Embed the full Basedash app (dashboards + chat) inside your product with JWT SSO.
Dashboard embedding
Dashboard embedding is best when you want to show a specific dashboard inside another app.Create an embed
- Open the dashboard in Basedash
- Click Share in the dashboard header
- Enable the Embedding toggle
- Copy the iframe snippet (or copy the plain URL)
/shared/{id} path.
Show or hide dashboard filters
In the share dialog, you can configure whether dashboard filters are visible in the embed. This is useful when you want a clean, fixed view (hidden filters) versus an explorable view (shown filters).Preset variable values via URL
If your dashboard uses variables, you can preset them via query parameters on the share link.- Use
evar_{variableSyntax}={base64Value} - Values are Base64 encoded
- URL-encode the Base64 string (for example, via
encodeURIComponent) - Only variables enabled for public sharing are supported
12345 is Base64 encoded as MTIzNDU=):
Full app embedding
Full app embedding is for customer portals where you want users to access Basedash inside your product, including building dashboards and chatting with the Basedash agent against their own data. Full app embedding uses JWT-based SSO inside an iframe:- Your backend generates a short-lived JWT for the current end user
- The iframe loads a Basedash SSO URL (
/api/sso/jwt?jwt=...) - Basedash validates the token, creates a session, and redirects into your organization
JWT SSO iframe URL
JWT claims
Your JWT must include:- email: The user’s email
- orgId: Your Basedash organization id
- exp: Expiration timestamp (keep tokens short-lived)
- iat: Issued-at timestamp
- firstName
- lastName
- role:
ADMINorMEMBER(used when creating a new member; defaults toMEMBER)
HS256).
Allowed embed origins
If your organization has an allowed origins list configured, Basedash will reject embeds that load from any other origin. Make sure the embedding page’s origin is included, and avoid using a referrer policy that strips theReferer header.
Troubleshooting
If the iframe shows an error page, the most common causes are:- Missing JWT parameter: your iframe URL is missing
?jwt=... - Embedding not enabled: embedding isn’t enabled for your organization
- Origin not allowed: add your site’s origin to the allowed origins list