---
title: Linking and Embedding Dashboards and Widgets
sidebar_label: Linking and Embedding
---

Using links, you can open running dashboards or Core+ widgets in dedicated browser windows. These links can be shared with users who have appropriate permissions or embedded in iframes within custom applications or web pages.

## Dashboard links

Dashboard links use two primary URL formats:

- **Standard URLs**—These are used by the Deephaven IDE. They navigate within Deephaven while showing the containing application.
  - Example: `https://mydeephaven.myorg.com:8000/iriside/dashboard/{dashboard-id}`
- **Embeddable URLs**—These do not show the containing application. They are the same as standard URLs but include `/embed` in the path. They are ideal for embedding in iframes within custom applications.

For example: `https://mydeephaven.myorg.com:8000/iriside/embed/dashboard/{dashboard-id}`

To create a shareable dashboard link:

1. Open the dashboard and note its URL format: `https://mydeephaven.myorg.com:8000/iriside/dashboard/{dashboard-id}`
2. Create the shareable version by adding `embed`: `https://mydeephaven.myorg.com:8000/iriside/embed/dashboard/{dashboard-id}`

## Widget links

Widget links support two formats:

- Query Name - `https://mydeephaven.myorg.com:8000/iriside/embed/widget/{query-name}/{widget-name}`
- Query Serial - `https://mydeephaven.myorg.com:8000/iriside/embed/widget/serial/{query-serial}/{widget-name}`

To create a shareable widget link:

1. Open the Persistent Query in the [Query Monitor](./query-monitor.md).
2. Note the name or serial, depending on which format you want to use.
3. Create the shareable version by replacing the `query-name` or `query-serial` and the `widget-name` placeholders in the respective URL format.

For example, you can link to the widget named `workspaceData` in the query named `WebClientData` with this link:
`https://mydeephaven.myorg.com:8000/iriside/embed/widget/WebClientData/workspaceData`

### Theming

You can specify the theme for your dashboard or widget link by providing an optional `theme` query string parameter. This can be any theme key supported by your server. By default, the `default-light` and `default-dark` themes should be available, but theme keys for custom themes installed on a server can also be used.

For example: `https://mydeephaven.myorg.com:8000/iriside/embed/widget/my-query/my-widget/?theme=default-light`

### Replica Slot

At times, it may be useful to target a widget on a specific replica slot for debugging purposes. To do this, you can include the replica slot's zero-based numeric index at the end of the URL path.

For example, to target the 3rd replica slot, you can use `https://mydeephaven.myorg.com:8000/iriside/embed/widget/my-query/my-widget/2`.

## Related documentation

- [Dashboards](./dashboards.md)
- [Permissions](./permissions.md)
- [Query Management](../../query-management/pq-overview.md)
