IMPORTANT: This document is specific to Sigma Workbooks.
Private embedding allows you to display your workbook in other applications. Your embedded data will update in real time with Sigma, as it responds to new data from your warehouse. A person must be logged in to Sigma to view a private embed.
Private embedding is one of three embedding options. To learn more about embedding in general and explore all three options, visit Workbook Embedding: An Overview.
Summary of Content
Who Can See my Data?
Private embeds are only visible to your Sigma organization’s members with access granted on the workbook. An organization member must be logged into their Sigma account to view the embed. If they are not logged into Sigma, the embed will prompt them to sign in to their account.
Creating a Private Embed
To create a private embed, you will need to create a private embed URL, and you or someone on your team will need to know how to inject the embed into your non-Sigma application using an iFrame.
Creating a Full Workbook Embed
- Open the workbook.
If the workbook is in a draft state, click the Publish button to publish or discard your draft.
Embeds always point to the published version of the workbook.
Copy the workbook's URL and add `?:embed=true`. The embed URL should look like this:
- In your non-Sigma application, add an <iFrame> element with “src” set to the embed link.
<iframe src="https://app.sigmacomputing.io/<your-organization-url>/workbook/<workbook-id>?:embed=true" />
Delete a Private Embed
Private embeds are created by adding "?:embed=true" to the end of a published workbook's URL. As such, nothing needs to be changed in Sigma to delete a private embed. You can however, remove the embed from the non-Sigma application. And the embed will also be broken if the workbook is deleted in Sigma.