Embed a view on a website
Show a live, read-only view of a diagram on your own site, intranet or documentation, with an iframe or through oEmbed, only on the sites you allow.
On this page
The embed code is an iframe that shows one view of a diagram: read-only, drawn by iyedy from the saved diagram, with pan, zoom and the view's title. Use it on your product's documentation site, your intranet, or any page that accepts HTML.
Before you start
- You are an editor of the diagram, or its owner, and the diagram is saved in your library.
- The diagram's classification is within the embed ceiling, Internal by default. Restricted diagrams are never embedded.
- An owner or security administrator can add your site to the sites allowed to show embeds.
Embed a view
- Allow your site
From the command palette (Ctrl K), open Integrations settings (embeds, Jira)…. Under Sites allowed to show embeds, add your site's address, such as
https://docs.claims.example, orhttps://*.claims.examplefor all its subdomains (scheme and host only). Select Save. - Create the embed link
Open the diagram, select Share…, then open Embed elsewhere. Choose the View, the Link lifetime and the Paper, then select Create embed link.
- Copy the embed code
The code is shown only once: select Copy embed code. It is an iframe whose address is the embed link.
- Paste it in your page
Paste the code where the view should appear, in the HTML of your page or in your site tool's HTML block. Set the frame's width and height to fit your layout.
Your page shows the view of Claims Platform; you can move and zoom in it.
oEmbed
The embed link also answers oEmbed, for tools that turn a pasted link into an embedded frame. Ask the share host with the embed link in url:
GET /oembed?url=https%3A%2F%2Fshare.iyedy.com%2Fe%2F…&format=json&maxwidth=800&maxheight=600 HTTP/1.1
Host: share.iyedy.com
The answer is an oEmbed response of type rich whose html is the frame. Only format=json is offered; xml answers 501. oEmbed answers only for embed links of iyedy.
What the embed page does and does not do
- It shows a drawing, never the model. The view is drawn by iyedy; the diagram's definition is not in the page.
- It sets no cookie and is not indexed by search engines, and it sends no referrer when a reader follows a link out.
- It shows only on the allowed sites. Inside any other site, browsers refuse to show it. Opened on its own, the link works for anyone who holds it until it expires or is revoked.
- Members can open the diagram. A member of the workspace gets an Open link to the diagram in iyedy.
- Free. On a Free personal account, the sheet carries the export mark under it.
- It has a rate limit: 300 requests a minute per reader address.
If it doesn't work
The frame stays empty or the browser refuses it
Your site is not in the sites allowed to show embeds, or its address differs (http instead of https, another subdomain). Add the exact host in step 1, then reload your page.
The view worked, then disappeared
The embed link expired or was revoked. Create a new one and replace the code in your page.
More symptoms, the same for every embed: Show a diagram in Confluence.
Was this page helpful?Your answer is anonymous and counts only if you accepted measurement.
What went wrong?
Don't write personal data.