In this QuickStart, we demonstrate how to embed a Sigma workbook without using JWT authentication.
Sigma supports public access embeds, which require no login and no token — anyone with the link can view the content. This allows us to present content outside of Sigma in a controlled, public-facing format.
To support this, we will adjust the HTML and iframe setup to use the base embed URL directly in the iframe, without appending a ?:jwt=
parameter.
This is ideal for use cases where:
1: Marketing Dashboards on Public Websites
2: Open Data Portals
3: Investor Relations Pages
4: Product Documentation with Embedded Analytics
5: Public Event or Conference Dashboards
6: Internal Kiosks or Wallboards (Non-sensitive)
Sigma supports embedding a workbook, individual page, or even a single element.
For more information on Sigma's product release strategy, see Sigma product releases
If something is not working as you expect, here's how to contact Sigma support
Semi-technical users who will be aiding in the planning or implementation of Sigma with embedding. No SQL or technical data skills are needed to complete this QuickStart. It does assume some common computer skills like installing software, using Terminal, navigating folders and copy/paste operations.
Since public embeds require no security, we can embed the iframe anywhere — such as on a website or internal page.
To create a public embed, we will need to complete a few steps in Sigma and in your host application.
Log into Sigma and navigate to any workbook you want to embed.
It doesn't matter which workbook you choose. Once you complete your first embed, this step becomes very straightforward regardless of embedding an entire workbook, page or single element.
We'll use one of the prebuilt templates included in a Sigma trial, but the steps are the same no matter what content you choose to embed.
After logging into Sigma, navigate to Templates
and click the Plugs Electronics Profit Planning Tool
example to open that template:
Click Save As
and name the workbook and name the workbook Embedding 15 - Public Access
.
We can continue editing the workbook, but changes will not appear in the public embed until the workbook is republished.
Open the workbook's menu and select Share and export
> Embedding
:
Select the Public
tab and Profit Planning Tool
from the list. Then click Copy
as shown, for the Public link
:
Now that we have the URL, we can use it in our sample host application.
In VSCode, open the embedding_qs_series_2
project and edit the .env
file to configure the public access settings.
In the # QS: public_access
section, set the parameters as shown, using your own base URL:
In the VSCode terminal, start the local web server:
npm start
In a browser, go to:
http://localhost:3000/public_access/?mode=public_access
You should see something like this:
Here are a few things to consider when working with public embeds.
In this QuickStart, we learned how to how to embed Sigma into a Public facing website.
Additional Resource Links
Blog
Community
Help Center
QuickStarts
Be sure to check out all the latest developments at Sigma's First Friday Feature page!