Frontend Setup

There are two ways to deploy dashboard in your front end:

iFrame Embedding
Native React Component Embedding 🔒

iFrame Embedding
Native React Component Embedding 🔒

Please click on the Deploy button in the Hub.

You will need to get the JWT for the current user and the dashboard ID to render the correct dashboard. The JWT is generated by following the steps in Backend Setup. The dashboard ID could be found in the URL when you are viewing the dashboard you want to embed.

Important: Changing the JWT token in the iframe src will cause the browser to reload the entire iframe. This happens automatically when:

The JWT expires and gets refreshed
User switches tenants/organizations
Tenant permissions are updated

Plan your token refresh strategy to minimize user disruption.

Below is an example of deploying component with JWT using Clerk middleware:

"use client";
import React from "react";
import { useUser } from "@clerk/nextjs";

const Analytics: React.FC = () => {
  // Get the user information from Clerk and extract the Upsolve token from the metadata
  const { user } = useUser();
  const upsolveToken = user?.publicMetadata?.["upsolveToken"];

  // Embed the component into your app
  return (
    <>
      {upsolveToken != null && typeof upsolveToken === "string" && (
        <iframe
          id="c5da5cb3-fedb-4656-9170-0cc65c9db29a"
          title="Example Dashboard"
          width="1000"
          height="1000"
          src={`https://hub.upsolve.ai/share/dashboard/c5da5cb3-fedb-4656-9170-0cc65c9db29a?theme=light&jwt=${upsolveToken}`}
        />
      )}
    </>
  );
};

export default Analytics;

Optional: Lock to a specific dashboard version

// Add &version=5 to lock to version 5
src={`https://hub.upsolve.ai/share/dashboard/c5da5cb3-fedb-4656-9170-0cc65c9db29a?theme=light&jwt=${upsolveToken}&version=5`}

Understanding JWT Changes and Iframe Refresh

When the upsolveToken value changes in the code above, React will re-render the component with a new src URL for the iframe. This causes the browser to completely reload the iframe content.

// Example: Token change triggers iframe reload
const Analytics: React.FC = () => {
  const { user } = useUser();
  const upsolveToken = user?.publicMetadata?.["upsolveToken"];

  // When upsolveToken changes (e.g., from token refresh or tenant switch),
  // the iframe src changes, triggering a full browser reload of the iframe

  return (
    <iframe
      src={`https://hub.upsolve.ai/share/dashboard/abc?jwt=${upsolveToken}`}
      // ↑ Changing upsolveToken here causes iframe reload
    />
  );
};

Common scenarios that trigger iframe reload:

Automatic token refresh (every hour)
User switches between tenants/organizations
User logs out and back in
Tenant permissions are updated

To improve user experience during token updates: 1. Cache the previous token until just before expiration 2. Show a loading overlay during refresh 3. Coordinate token updates during natural breaks in user workflow

Database Row-Level Security (RLS) Setup 🔒

For databases with Row-Level Security policies (Postgres, Redshift, or Supabase), you need to include a database auth token (dbAuthToken) in the iFrame src URL. This token identifies the current user and is used by your database’s RLS policies to filter data at the row level.Example updated iFrame URL:

<iframe
  id="c5da5cb3-fedb-4656-9170-0cc65c9db29a"
  title="Example Dashboard"
  width="1000"
  height="1000"
  src="https://hub.upsolve.ai/share/dashboard/c5da5cb3-fedb-4656-9170-0cc65c9db29a?theme=light&jwt=<upsolveToken>&dbAuthToken=<yourDbAuthToken>"
/>

dbAuthToken: The user-specific identifier that your RLS policies use for row-level filtering

For Postgres and Redshift

The dbAuthToken should contain the value that matches your RLS session variable (e.g., tenant ID, user ID, or company code):

const Analytics: React.FC = () => {
  const { user } = useUser();
  const upsolveToken = user?.publicMetadata?.["upsolveToken"];
  const tenantId = user?.publicMetadata?.["tenantId"]; // Your user's tenant/company identifier

  return (
    <iframe
      src={`https://hub.upsolve.ai/share/dashboard/abc123?jwt=${upsolveToken}&dbAuthToken=${tenantId}`}
    />
  );
};

Learn more about setting up RLS for Postgres and Redshift in the Database Row-Level Security guide.

For Supabase

To retrieve the Supabase session token (dbAuthToken), you can use Supabase’s auth.getSession method:

import { createClient } from '@supabase/supabase-js';

const supabase = createClient(
  'https://your-supabase-project.supabase.co',
  'public-anon-key'
);

async function getDbAuthToken() {
  const {
    data: { session },
    error,
  } = await supabase.auth.getSession();

  if (error) {
    console.error('Error retrieving session:', error.message);
    return null;
  }

  return session?.access_token;
}

getDbAuthToken().then((dbAuthToken) => {
  console.log('dbAuthToken:', dbAuthToken);
  // Use dbAuthToken in the iframe URL
});

Refer to the Supabase API docs for more details on managing sessions and tokens.

Deploying AI Chat

There are two ways to deploy AI chat in your front end:

iFrame Embedding
Native React Component Embedding 🔒

iFrame Embedding
Native React Component Embedding 🔒

You’ll need to get the JWT for the current user and the agent ID to render the chat interface. The JWT is generated by following the steps in Backend Setup.

Getting the Agent ID

You can find your agent ID by visiting your agents at https://ai-hub.upsolve.ai/agents. The agent ID is visible in the URL when you click on an agent, or in the agent list view.

Authentication via JWT: Chat iframes use JWT tokens passed via query parameters for authentication, similar to dashboards. Users don’t need to be logged into the Hub - they just need a valid JWT token in the URL.

Important: Changing the JWT token in the iframe src will cause the browser to reload the entire iframe and reset the chat session. This happens automatically when:

The JWT expires and gets refreshed
User switches tenants/organizations
Tenant permissions are updated

Each iframe load starts a fresh chat session. Plan your token refresh strategy carefully to avoid interrupting active conversations.

Below is an example of deploying chat with JWT using Clerk middleware:

"use client";
import React from "react";
import { useUser } from "@clerk/nextjs";

const AIChatInterface: React.FC = () => {
  // Get the user information from Clerk and extract the Upsolve token from the metadata
  const { user } = useUser();
  const upsolveToken = user?.publicMetadata?.["upsolveToken"];
  const agentId = "your-agent-id"; // Replace with your agent ID

  // Embed the chat component into your app
  return (
    <>
      {upsolveToken != null && typeof upsolveToken === "string" && (
        <iframe
          id={agentId}
          title="AI Chat"
          width="100%"
          height="800"
          style={{ border: "none" }}
          src={`https://hub.upsolve.ai/share/chat/${agentId}?jwt=${upsolveToken}&theme=light`}
        />
      )}
    </>
  );
};

export default AIChatInterface;

Dashboard Query Parameters

The dashboard iframe supports the following query parameters:

Parameter	Type	Required	Description
`jwt`	string	Yes	Tenant JWT for authentication
`theme`	`light` \| `dark`	No	Visual theme
`version`	number	No	Lock to a specific dashboard version (defaults to latest)
`hideHeader`	boolean	No	Hide the header UI
`hideDownloadButton`	boolean	No	Hide the download button
`themeConfigs`	JSON string	No	Custom theme configuration
`dbAuthToken`	string	No	Database authentication token for RLS (see RLS section)
`filter_{key}`	any	No	Controlled filter values (e.g., `filter_region=US`)

Version Locking

You can lock an embedded dashboard to a specific version using the version parameter. This ensures that the dashboard renders with a specific configuration, even if newer versions are published.

<iframe
  id="c5da5cb3-fedb-4656-9170-0cc65c9db29a"
  title="Example Dashboard"
  width="1000"
  height="1000"
  src="https://hub.upsolve.ai/share/dashboard/c5da5cb3-fedb-4656-9170-0cc65c9db29a?theme=light&jwt=<upsolveToken>&version=5"
/>

Version locking is useful when: - You want to maintain consistency across deployments - You need time to test new dashboard versions before deploying them - Different customers should see different versions of the same dashboard

Chat Query Parameters

The chat iframe supports the following query parameters:

Parameter	Type	Required	Description
`jwt`	string	Yes	Tenant JWT for authentication
`prompt`	string	No	Initial prompt to start the conversation
`theme`	`light` \| `dark`	No	Visual theme
`isAdmin`	boolean	No	Enable admin features (default: `false`)
`hideHeader`	boolean	No	Hide the header UI
`themeConfigs`	JSON string	No	Custom theme configuration

Example with Initial Prompt

const AIChatWithPrompt: React.FC = () => {
  const { user } = useUser();
  const upsolveToken = user?.publicMetadata?.["upsolveToken"];
  const agentId = "your-agent-id";
  const initialPrompt = "What were our top sales last quarter?";

  return (
    <iframe
      src={`https://hub.upsolve.ai/share/chat/${agentId}?jwt=${upsolveToken}&prompt=${encodeURIComponent(
        initialPrompt
      )}&theme=dark`}
      width="100%"
      height="800"
      style={{ border: "none" }}
    />
  );
};

Admin Mode

By default, the chat interface runs in end-user mode with simplified views. Set isAdmin=true to enable detailed tool execution information:

<iframe
  src={`https://hub.upsolve.ai/share/chat/${agentId}?jwt=${upsolveToken}&isAdmin=true`}
  width="100%"
  height="800"
/>

Understanding Session Reset on JWT Change

When the upsolveToken value changes, React re-renders the iframe with a new src URL. This causes the browser to completely reload the iframe and start a new chat session.

// Example: Token change triggers iframe reload and session reset
const AIChatInterface: React.FC = () => {
  const { user } = useUser();
  const upsolveToken = user?.publicMetadata?.["upsolveToken"];

  // When upsolveToken changes, the chat session resets
  return (
    <iframe
      src={`https://hub.upsolve.ai/share/chat/abc?jwt=${upsolveToken}`}
      // ↑ Changing upsolveToken resets the entire conversation
    />
  );
};

Common scenarios that trigger session reset:

Automatic token refresh (every hour)
User switches between tenants/organizations
User logs out and back in
Tenant permissions are updated

To preserve chat history across token refreshes, consider: 1. Implementing session persistence on your backend 2. Storing conversation history outside the iframe 3. Refreshing tokens during natural conversation breaks 4. Warning users before token expiration

Embedded BI

Data Connection

Charts

Dashboards

Scheduled Reporting

Filtering

Data Permissioning

Customize

Dashboard Deployment

Sharing and Export

Understanding JWT Changes and Iframe Refresh

For Postgres and Redshift

For Supabase

Deploying AI Chat

Getting the Agent ID

Dashboard Query Parameters

Version Locking

Chat Query Parameters

Example with Initial Prompt

Admin Mode

Understanding Session Reset on JWT Change

Embedded BI

Data Connection

Charts

Dashboards

Scheduled Reporting

Filtering

Data Permissioning

Customize

Dashboard Deployment

Sharing and Export

​Understanding JWT Changes and Iframe Refresh

​For Postgres and Redshift

​For Supabase

​Deploying AI Chat

​Getting the Agent ID

​Dashboard Query Parameters

​Version Locking

​Chat Query Parameters

​Example with Initial Prompt

​Admin Mode

​Understanding Session Reset on JWT Change

Understanding JWT Changes and Iframe Refresh

For Postgres and Redshift

For Supabase

Deploying AI Chat

Getting the Agent ID

Dashboard Query Parameters

Version Locking

Chat Query Parameters

Example with Initial Prompt

Admin Mode

Understanding Session Reset on JWT Change