Skip to main content

Developer platform and APIs

Discuss everything related to Miro API, SDK, embedding and Miro Platform apps development.

  • 1,123 Topics
  • 3,435 Replies
1123 Topics
S
StonelliBeginner
posted in Developer platform and APIs
Looking for a Miro developer for an extended card functionality

Hi,we’re looking into extending the functionality of the current cards on Miro.Firstly, I’m a simple Miro user, and have no idea of how to develop an app/ add-in, how to work with APIs, SDKs or whatsoever, all of that is cryptic to me. And that will stay so because I don’t need to.So I’m looking for someone who could develop an extended card function we can use.Basically I want to create a set of cards (think board game) which I can put on a Miro board. They have two sides: the front side has an image, a single sentence, and possibly a colour code (to group cards) – very similar to the existing card functionality.The back side is rich-text/ rich-media, containing text, tables, links, images, maybe videos, … (the default card functionality allows for bold/ italic text, for lists, and links, but nothing more, which is insufficient).It would be lovely if it created the impression that the card is flipped over, but just “expanding” it would work, too. It’s just important that I can fully c

2036
Adilson Simoes
M
Mark MarijnissenBeginner
posted in Developer platform and APIs
WebSDK & REST API

Users use an installation link to install the plugin. How do I get an access token to use for the REST API?The SDK only offers `miro.getIdToken`, but not an accessToken. Use CaseI have a plugin that can drag & drop elements into the Miro board. Users can purchase additional elements to drop. Therefore, I have a backend that keeps track of user purchases.Web SDK initializes plugin. I use `miro.getToken()` (deprecrated) in the Web SDK to retrieve a token. I make an API call to the backend, using this token. My backend uses https://api.miro.com/v1/users/me to retrieve the e-mail address. I cross-reference the e-mail with the purchases in the web-shop to unlock purchased products for this user (*)With the deprecation of `getToken()`, I cannot access the REST API anymore. The new idToken returns 401 Unauthorized.*) Actually ​​​​​​, this is a bit different, but doesn't matter for this context.

2941
Anthony Roux
Mironeer
S
saifisBeginner
asked in Developer platform and APIs
How to get drag and drop event to get coordinates

I’m making an app where dropping a card on top of a shape object needs some functions to be called, so I want to catch when cards are moved, I tried using “WIDGETS_TRANSFORMATION_UPDATED”  but it doesn’t give coordinates, I’ve tried getting the common ‘dragend’ on document and it did no go well either, any suggestions would be greatly appreciated.

32723
J
M
mrowe23New Here
asked in Developer platform and APIs
Suggestions/Proxy Application Templates for Azure?

Hello,We are looking to integrate creating and displaying MIRO boards in SharePoint Online.  It looks like MIRO doesn’t allow cross domain REST calls(CORS security) from the browser.  We are looking to create a web application in Azure to be a proxy. Is there any Azure articles/apps already created for MIRO proxies that can help us get started?  Thank you,Mike 

732
M
G
Gaurav YadavNew Here
asked in Developer platform and APIs
DOMException: Failed to execute 'postMessage' on 'Window': Response object could not be cloned.

When using `Editable boards for not registered users`, when I click on “Create Board”, I am getting an alert message saying “miro.com says Something went wrong” and in my console I get 2 errors`DOMException: Failed to execute 'postMessage' on 'Window': Response object could not be cloned.``Uncaught (in promise) DOMException: Failed to execute 'postMessage' on 'Window': Response object could not be cloned.` It works fine for users that have already registered with Miro. I have attached the necessary screenshots below.Error when clicking on “Create Board”Code for opening the board picker   

88612
G
D
David RichardsonNew Here
posted in Developer platform and APIs
Extract Card Names From a Board

Hi.I need to extract the names of cards from a board programmatically.Been reading your REST API documentation.Am confused about how to generate the access token.We use Azure AD as our Authorisation Server.Do you have some really simple examples of how to do this?Many thanks.Dave.

1043
Anthony Roux
Mironeer
N
NiucoBeginner
asked in Developer platform and APIs
Developer Account

Hello, I'm developing an App but I have to test it by using an endpoint that is just available for Paying accounts. Is there any developer account for this case? Cheers

1365
Anthony Roux
Mironeer
ronny
ronnyContributor
asked in Developer platform and APIs
Upload image into board

I managed to upload the logo of the board via the picture endpoint (https://developers.miro.com/reference#create-or-update-picture). How can I upload an image to the board itself? Use case: We want to upload our logo via the API when creating new boards.

53536
Anthony Roux
Mironeer
M
Mariappan SubramanianNew Here
asked in Developer platform and APIs
Getting user is not in account when hitting share board api

Hi, As per documentation `https://api.miro.com/v1/boards/id/share` requires array of emails Array of emails of users who you want to invite to the board. These users can be registered or non-registered.When I try with a non-registered user it gives the error ‘user is not in the team’. Why is it so? Can’t we invite someone who is not in the team even if it’s a public shared board? If we need to do this, should we initially hit the invite to team endpoint & then call this endpoint. Response: 400 "{ "status" : 400, "code" : "userIsNotInAccount", "message" : "User is not in account", "type" : "error" }"

3861
Anthony Roux
Mironeer
P
PetterNew Here
asked in Developer platform and APIs
Miro enterprise license - whiteboard, chat and video with guests

Hi all,We have an enterprise plan with Miro, and we want to use both chat and video with our guest users. We are planning to integrate Miro with ServiceNow, create a board via REST API, and then sharing the link with our users so they can share a whiteboard session including chat & video.Is it possible to use both chat AND video with guest users, if you have an enterprise plan? Also, is it possible to use some sort of templating for the boards you create? Like adding some text, or welcoming message on the board when it opens? Best regards,P

731
Rich Moore
Mironeer
Bentley Davis
Bentley DavisBeginner
posted in Developer platform and APIs
Error when using Airtable (and other npm packages) with create-miro-app React Typescript

Has anyone else tried using libraries with the create-miro-app React TypreScript option? I followed the Hello World Miro example and it works fine but when I add Airtable and even though none of the Airtable code runs I receive the error:Uncaught Error: Module "stream" has been externalized for browser compatibility and cannot be accessed in client code. at Object.get (browser-external:stream:3) at node_modules/node-fetch/lib/index.mjs (index.mjs:10) at __init (chunk-EB7XYW2R.js?v=d66c9224:9) at node_modules/airtable/lib/fetch.js (fetch.ts:2) at __require2 (chunk-EB7XYW2R.js?v=d66c9224:12) at node_modules/airtable/lib/base.js (base.ts:4) at __require2 (chunk-EB7XYW2R.js?v=d66c9224:12) at node_modules/airtable/lib/airtable.js (airtable.ts:1) at __require2 (chunk-EB7XYW2R.js?v=d66c9224:12) at dep:airtable:1I have spent several hours looking it up and trying different options but even though the error changes I have not been able to make it work. Here is a sa

6884
A
J
John RocheBeginner
asked in Developer platform and APIs
User Bearer Token returning Unauthorised from API call.

I have a user on the system whose User Bearer Token is returning Unauthorised when we call the Miro API. Other users bearer tokens are fine with the same calls.Can you please let me know how to refresh the bearer token for this user or enable this token to be authorized?This user has many associated boards which they will still need to be able to retrieve.

1824
J
K
Kamalesh JoshiNew Here
posted in Developer platform and APIs
Uncaught in promise error

I am developing a plugin using web api, where I read the miro board contents from javascript:Sample code:async function javascriptFunction() {          let selectedWidgets = await miro.board.selection.get() }This code works fine first time, but when the app is launched again, it gives error: Uncaught (in Promise) TypeError: cannot read property 'selection’ of undefined.  Anyone else faced this issue? 

3351
Anthony Roux
Mironeer
F
ftassiNew Here
posted in Developer platform and APIs
WebPlugin error. Uncaught Error: processCommandFromIFrame:: iframe channel not found

Hi, I’ve created a simple test plugin using one of the examples app as a scaffolding. The web plugin allows the user to roll a number of random dice. This is the installation link for the  app (still in development of course) https://miro.com/oauth/authorize/?response_type=token&client_id=3074457350145576827&redirect_uri=https://miro-rory-story-cubes-prod.herokuapp.com/auth-success.htmlThe app seems to work fine most of the time but for some users and on some teams, it works just once. After first usage we get this error:Uncaught Error: processCommandFromIFrame:: iframe channel not found, plugin = 3074457350145576827, cmd = .board.viewport.getViewportIf we reload the board and use it, it works the first time and triggers the error from then on.The issue seems to be consistent for certain combination of user/team/browser. EgI can use it on Team A, always I can use it on Team B, always, using firefox I can use it on Team B, only once, using chrome A teamamate can use it on Team B

6673
G
M
Manjula ManoharanBeginner
asked in Developer platform and APIs
Issue while embedding link

I am using Angular 6 , and when I tried to embed the below link <iframe [src]='https://miro.com/app/board/o9J_ldxFWKw=/'></iframe> I am getting the below error in console.Refused to display 'https://miro.com/app/board/o9J_ldxFWKw=/' in a frame because it set 'X-Frame-Options' to 'sameorigin'. any help would be highly appreciated.

13753
L
ronny
ronnyContributor
posted in Developer platform and APIs
Label widgets via API

We try to add labels to widgets via the API (as you can do in Miro UI) but we fail to find out to do this via the REST API. Could you point to docu how to do this? PS: Our use case is to set the labels during createWidget request.  

224317
Anthony Roux
Mironeer
M
Mike HosseiniNew Here
asked in Developer platform and APIs
Integration issues....

We have two main issues integrating with Miro: App URL + BoardPicker AllowList: since every single user in our app has a workspace URL subdomain, we need that Miro accepts a wildcard name here. Like *.domain.com Enabling boardPicker: by default, this feature is disabled, and Miro's users should submit a form to activate it. We have submitted that form twice, months ago, and didn't get any response from them. Can someone from the team please help us out with these?Regards,Mike

672
M
C
Charles FriedoBeginner
asked in Developer platform and APIs
How I can import visualization in miro from Google Sheets and/or Excel?

Hey Friends,I am creating data visualizations on different domain data.Normally I am using Google Sheets for No Code add-on for this purpose.I have more knowledge about Excel & Office 365 use code free add-in for data visualization purpose.Recently created Sankey chart (Users Search Terms Flow in running campaign) with these add-ins. Image is attached. How I can import this chart in miro for data story telling purpose.Thanks--CF   

35312
Max Harper
R
RamkumarBeginner
posted in Developer platform and APIs
Bug - Miro selection API doesn't allow edit

Hi,When selecting widgets with Miro SDK, widgets get selected as expected but they don’t allow regular keyboard edit options like delete or arrow keys for nudging. The same work as expected when widgets are selected manually.miro.board.selection.selectWidgets([...selectableWidgets]);Regards,Ramkumar

602
Anthony Roux
Mironeer
Iraklis Alexopoulos
Iraklis AlexopoulosBeginner
posted in Developer platform and APIs
Transfer Miro embed app ownership

Hi there, I am trying to transfer an app that was created from a developer that used to work with us under my account. Apparently, I am listed as a team member in this app, but it’s nowhere to be seen under the apps that I can see in my dashboard. Who should I reach out to? Thanks,Iraklis

623
Iraklis Alexopoulos
I
Imi TuriNew Here
asked in Developer platform and APIs
AWS Icons from API

Hey, I wonder if I missed something in the API docs, but seems like currently it’s not possible creating objects from the AWS icon set via the API.Can you please provide some timing on this? 

2101
Anthony Roux
Mironeer
J
Justin BarrettBeginner
asked in Developer platform and APIs
Board name length limit missing from API docs

I just discovered the hard way that there’s a name length limit for Miro boards when creating them via the API: 60 characters. I discovered this when a client reported that a system that I’d built for him to automatically create new Miro boards for his projects came back with a failure on one particular project. In the API call, the only thing that I’m passing is the board name, and the intended board name for this project was 66 characters long. Through trial and error, I found the 60 character limit, but was a bit frustrated that this isn’t mentioned in the API docs.Could someone please update the docs to mention this limit, and maybe any other name length limits that need to be considered when using the API?

1192
J
K
Kaur KuutBeginner
posted in Developer platform and APIs
Miro - where teams get no events?

I am talking about the Miro web plugin SDK and its capabilities.The main Miro landing page talks about how great Miro is for teams and collaboration. So you can imagine my surprise to learn that the SDK events are only for single user boards. There are no events for changes to the board made by my team!What makes this even more bizarre, is that these events do exist under the hood. When a team member moves a widget around, I can see it moving around on my Miro board. When a team member creates a new widget, it immediately appears in my view too!So I’m left only to speculate why these events aren’t propagated through the SDK and instead the SDK gets filtered events of only actions that I myself have done.Please tell me there are plans to add SDK event support for boards used by more than one person. It would allow for much more advanced and live collaboration oriented plugins. PS. I am aware of extreme workarounds like building a state machine with a hidden widget, or a state machine on

1341
Anthony Roux
Mironeer
A
Andreas S.New Here
asked in Developer platform and APIs
Metadata not returned via JS SDK for widgettype=CARD

Hi, this topic is maybe connected to https://community.miro.com/developer-platform-and-apis-57/unable-to-get-card-metadata-with-rest-api-1921. But in my opinion it was not answered becuase the question was about widgetType=CARD and the answer was widgetType=STICKER. So:I created a CARD via REST API (POST https://api.miro.com/v1/boards/${this._miro.boardId}/widgets ) with a metadata. I created a STICKER via REST API (POST https://api.miro.com/v1/boards/${this._miro.boardId}/widgets ) with the exact same metadata object like in 1. In the Browsers DEV Console I did a miro.board.widgets.get({id: "<id of the created STICKER>"}) → Result: the metadata was returned as expected In the Browsers DEV Console I did a miro.board.widgets.get({id: "<id of the created CARD>"}) → Result: the metadata object was empty. Expected was the same metadata content like in 3.So for me the behaviour for CARDs is different from the behaviour of STICKERs. Does this somehow make sense? Sorry if not repr

1091
Falk Kühnel
K
Kaur KuutBeginner
posted in Developer platform and APIs
High frequency transformation update event

I am talking about the Miro web plugin SDK and its capabilities.I am successfully using the WIDGETS_TRANSFORMATION_UPDATED event to react to widget transformations like resizing and draging.The problem is with the eventually consistent nature of this event. The event only fires when I release my mouse button and stop resizing or moving a widget. I would like to react to these changes quicker on the fly as the widget is still being resized or moved around.The basic use case is that I want to change the background color of sticky notes depending on their location on the canvas. Currently the user has to already know where these special areas are and then drop the widget in that location. It would be a much smoother user experience if I could update the color of the sticky note immediately as it enters the correct area.This type of feature is known as a drop hint and it is commonly found in high quality UIs.The Miro web client already has all this data, because obviously the vanilla widge

1083
Anthony Roux
Mironeer
Terms & Conditions