Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.omni.co/llms.txt

Use this file to discover all available pages before exploring further.

If your team runs on Notion - wikis, project docs, team pages - embedding Omni dashboards lets you incorporate live data right alongside the context that explains it. Instead of linking out to a separate BI tool, readers can see the numbers inline as they scroll through a planning doc, team update, or KPI page. This guide walks through embedding an Omni dashboard in a Notion document using an iframe.

Limitations

While not required, viewing the Omni iframe in Notion works best on the web version of Notion.

Requirements

To follow this guide, you’ll need:
  • Permissions in Omni that allow you to access the dashboard you want to embed
  • Permissions in Notion that allow you to create and edit documents
Additionally, users who view the Omni iframe in Notion must have permissions in Omni that allow them to view the dashboard being embedded. Viewers of the content will be prompted to log in using the iframe and if they have sufficient permissions, the content will display.
1

Retrieve the dashboard's embed URL

  1. In a published Omni workbook or dashboard, click the Share button to open the share modal. You can also navigate to File > Document settings.
  2. Click Embed.
  3. If desired, use the options in this tab to customize what content is embedded and how it displays for users. For example, you could embed a dashboard and only display it in dark mode. See Customize embedded content for more information. Omni share modal with embed options
  4. Click the Copy button to copy the iframe URL. The example iframe URL below is for an Omni instance named blobsrus and includes settings for Light/dark mode (prefersDark) and Theme (theme): 
    <iframe src="https://blobsrus.omniapp.co/dashboards/a0554a7e?prefersDark=true&theme=dawn"></iframe>
  1. In a text editor, only copy the Omni URL. For example, if you copied a string like the following: 
    <iframe src="https://blobsrus.omniapp.co/dashboards/a0554a7e"></iframe>
    You will only want the URL: 
    https://blobsrus.omniapp.co/dashboards/a0554a7e
2

Create an embed component in Notion

  1. In a Notion document, use the /embed command to create an embed component.
  2. Paste the Omni URL into the field: Notion embed component with the Omni dashboard URL pasted into the link field
  3. Click Embed link.
3

Test the iframe

Your Omni dashboard should now be embedded in Notion! 🎉Before you share the Notion document with other users, use the iframe to log into Omni. This allows you to check that the workbook or dashboard displays correctly after authentication.An Omni dashboard embedded and rendered inside a Notion document
4

Share the Notion document

Share the Notion document with other users in your Notion instance. Note: Users will have to log into Omni with the iframe before they can view the workbook or dashboard content.