Miro Developer Platform

Enhance Miro to fit the way you work

Automate, extend, and customize Miro to fit your teamwork.
Create Apps that combine Rest API, Webhooks and Web-Plugins.
Bring your collaboration to the next level.

Get Started

[NEW WIP] Embed Miro Whiteboard

Why embed Miro Whiteboard?

Embedding a Miro board is a great way to share your work or inspire collaboration. All the changes you make to the board are reflected in the embedded window live. Miro embed is an iframe-based solution that makes it easy for using the entire Miro experience right in your app or website.

Miro Whiteboard is a great addition to business tools, video conferencing apps, and education platforms.

What is the cost of embedding Miro?

It is free to embed Miro into any web application, product or website.

What solutions can you build with Miro Whiteboard?

Solution 1: Let users of your tool create an instant whiteboard without registration during a video conferencing session

What is the user experience?
Users are prompted to create a board without registration or sign in to Miro and choose an existing board. When going with the first option, users get a full-featured collaborative Miro whiteboard, editable for everyone with access to that iframe.

This board will be temporary and will be deleted 24 hours after creation.
There is a button to save this board to the user's own Miro team, so users can sign up with Miro, save the board and continue their work without any limits.

See Miro + Whereby integration to check the experience yourself.

What is the technical implementation?
Technically, there are 2 steps:

  • Call boardsPicker component with ‘anonymous boards’ option
  • Embed the board using access-link that you receive from boardsPicker once user has chosen to create a board

Here is a guide on how this solution should be implemented.
This option require enablement on the Miro side. Please send us your application's client_id via this short form

What Miro subscription is required?
No Miro subscription is required for this solution to be built.
You only need to create a free Dev Team and an application that you will use to sign your requests to boardsPicker.

In what case I need this solution?
You should use this solution if you want users of your tool to collaborate on ad-hoc topics, without any preparation from their side. Currently this solution does not support any templates or UI customization.

Solutions 2: Let existing Miro users embed their boards for collaboration and knowledge sharing

What is the user experience?
There are 2 options to build this solution:

  • Let users paste URLs to their boards, and make those URL embeddable. In this case, the board will only be accessible by those user who have access to the actual board. Eg, if the board is private, only logged in users from the same team will access it, and if the board is shared for view by public link, then everyone will be a viewer on that board.
  • Provide user UI, called boardsPicker to actually pick a board right from the board list. In that case, users would be able to set additional access-rights for this embed.

In both cases, the end result is live embedded Miro Whiteboard on which users of your app can collaborate and share ideas.

See Miro + Notion integration to check experience of pasting the URL and Miro + Coda integration to check the experience with boardsPicker.

What is the technical implementation
For the first option, where user provides you URL of the board, you need to take id of that board from the URL and append it to the following URL: https://miro.com/app/live-embed/{board_id}
Read more about this solution and additional parameters that can be used.

To implement option where user picks board from a UI, you need to implement following 2 steps:

  • Call boardsPicker component
  • Embed the board using access-link that you receive from boardsPicker once user has chosen the board

Here is a guide on how to implement boardsPicker option.
This option require enablement on the Miro side. Please send us your application's client_id via this short form

What Miro subscription is required?
No Miro subscription is required for this solution to be built.
You only need to create a free Dev Team and an application that you will use to sign your requests to boardsPicker.

However users of these solutions are expected to have their own Miro teams and boards.
Such solutions can be used by Miro users of any subscription plan, including Free.

In what case should I need this solution?
This solution suits you if you want to embed Miro into static environments, like documentation services or project management tools. It also suits for LMS integrations, when a tutor adds a board to the course as part of learning or training materials.

FAQ's

Q: How much does it cost to embed Miro into my website?
A: There is no price tag to embed Miro, but we review applications that embed Miro boards and boards picker. We expect these to be business, video conferencing, and education tools.

Q: What are possible user flows?
A: You can implement one of the 2 flows:

  • allow existent Miro users to embed their boards into your website,
  • allow any user to create an empty Miro board without registering with Miro. The board will be deleted after 24 hours if the user does not move to one’s own Miro team.

Q: How can I get access?
A: Feel out this form to enter the waiting list of Miro embed partners. We will be in touch with you shortly.

Updated 4 months ago



[NEW WIP] Embed Miro Whiteboard


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.