Skip to main content

Developer platform and APIs

Discuss everything related to Miro API, SDK, embedding and Miro Platform apps development. See documentation at <a href="https://developers.miro.com/docs">developers.miro.com</a>

  • 941 Topics
  • 3,010 Replies
941 Topics
Sami Ljimari
Sami LjimariActive Contributor
asked in Developer platform and APIs
Text widget width attribute, multiple occurances

Tried to find my answers in the doucumentation for text widgets, but without much success. This is what I’m looking at:I can’t figure out which width attribute corresponds to what exactly since they are both different in value. And if both of these width attributes impact something different, or if they both just determine the actual width of the text widget, where one of the attributes has priority over the other.  Also the reason why I would even want to set width manually, is that when creating a text widget with a API call and simply giving it some text, it doesn’t determine the expected width well enough, for the text to fit in a single line.The call beneath will give me this result ^await miro.board.widgets.create({       "capabilities" : {          "editable" : true      },      "scale" : textSize,      "rotation" : 270,      "style" : {        "backgroundColor" : "transparent",        "backgroundOpacity" : 1,        "bold" : 0,        "borderColor" : "transparent",        "bord

2
Sami Ljimari
3 years ago
Sami Ljimari
Sami LjimariActive Contributor
asked in Developer platform and APIs
'zoomToObject' is deprecated api. It will be removed soon.

As stated in the title, 'zoomToObject' is deprecated api. It will be removed soon. pops up in console everytime I use the “await miro.board.viewport.zoomToObject(widgetID);” command.  It is nice that you warn users that a certain functionality will be removed, but some insight as to why this would be removed and maybe what will replace this functionality and when would be welcomed too, because right now I cannot find any other suitable command which could replace zoomToObject in my app.  Maybe keeping a update log page with scheduled updates including scheduled API changes would help, or generally just some form of communication and updates about API issues, like updating metadata  which has been now broken for over a month. 

1
Anthony Roux
Mironeer
3 years ago
P
PatrickOMBeginner
asked in Developer platform and APIs
Client Authentication

hi everyone,What I’d love to do is allow users of our product to connect their account to our product (like Salesforce connect or creating a connected account in Stripe if anyone is familiar with those). The way this would workClient would generate a key / secret for Miro Client would input that in our products dashboard We can now dynamically create whiteboard for them in various meetings/events they they have in our product using the rest API Does anyone know if this is possible? Or is anyone doing anything similar - even with a workaround? thanks,Patrick Note: I had a good look through existing forums but didn’t see an obvious answer to this which is why I am creating a new thread

5
P
3 years ago
M
manavb1Beginner
posted in Developer platform and APIs
Property 'requestAuthorization' does not exist on type 'Root'.

I am trying to migrate to miro.requestAuthorization, but I get the above error. Anyone know how to fix it?

1
Anthony Roux
Mironeer
3 years ago
A
annie.maria_extBeginner
posted in Developer platform and APIs
Viewers cannot see the custom Icons added in bottom bar

I have build an app in Miro by following the guide Build Your App (miro.com) . I have created a Html file (using a custom web api that is hosted in Azure) that adds 2 Icons in the bottom bar of the board and added the linkto the App URL field.The app works fine for the board owner and users with Edit access to the board, i.e. they are able to see the icons and redirect to another page on click. But, the issue occurs in the users with viewer and commenter - they are not able to see the Icons and I can see that in the sources (in developer tools ), the html file is not loading.Could you please confirm if this is the default behavior of Miro and if there is any workaround for this. 

5
Sami Ljimari
3 years ago
M
manavb1Beginner
asked in Developer platform and APIs
Migrating from getToken() to getIdToken()

I’m unsure how to go about migrating from getToken() to getIdToken(), currently I have this code to make a request to my Api. const appId = miro.getClientId(); const clientId = appId.toString(); let token = await miro.getToken(); let boardInfo = await miro.board.info.get(); let teamInfo = await miro.account.get(); console.log(token) return this.makeCall(() =&gt; fetch(`${this.baseUrl}/${clientId}/team/${teamInfo.id}/JiraCard/board/${encodeURIComponent(boardInfo.id)}`, { method: 'POST', headers: { 'Authorization': 'Bearer ' + token, 'Content-Type': 'application/json' }, body: JSON.stringify({ "issueKey": issueKey, "x": x, "y": y }) }), (successResponse) =&gt; successResponse.json())If I replace getToken() with getIdToken() the OAuth Token is invalid, as getIdToken() returns a different type of token. How exactly do I go about decod

1
Anthony Roux
Mironeer
3 years ago
T
Tim AltendorfNew Here
asked in Developer platform and APIs
Get boards by Project

Hi!Is there a way to get only the boards grouped in a certain Project via the Rest API?  

1
Anthony Roux
Mironeer
3 years ago
J
Judd MaltinBeginner
asked in Developer platform and APIs
API automation / use case feasibility for Automated Framing

Hi! Use Case:I’m considering diving into the API to try to automate the upload of PDFs, extracting all their pages, laying them out in a specific layout, and then framing each page.Is this at all feasible?Thanks!-judd

4
J
3 years ago
Sami Ljimari
Sami LjimariActive Contributor
posted in Developer platform and APIs
Miro CSS double icon bug

Tried to use some Miro CSS classes today and noticed that the miro-select class spawns 2 icons, while miro-select--small only one. Could this be fixed?  

2
Sami Ljimari
3 years ago
S
Soham PatelNew Here
posted in Developer platform and APIs
Error : Something went wrong while trying to create temporary board for anonymous users

Hello community, I’m a beginner and trying to embed a whiteboard in my website via “Temporary boards for anonymous users” approach I have added a button and on that button, I have added click event listener. That event listener will initialise the board picker(same steps mentioned in documentation). When I click that button, boards picker opens in new window and offers 2 options : 1) Sign In 2) Create Board When I click create board, It displays alert : “SOMETHING WENT WRONG” May be I’m making some mistake while generating JWT token. Here is the way I generate a token(in python back-end) : -  def generate_token(request):client_id = 'MY_CLIENT_ID'secret = ‘MY_SECRET’token = jwt.encode({"iss" : client_id}, secret , algorithm="HS256")return Response({"token" : token}) Here is the click event listener which initialise the boardsPicker: const onClick = function () {console.log("clicked")miroBoardsPicker.open({clientId: "MY_CLIENT_ID", // 1) Put your 'clientId' here.action: "access-link",all

3
S
2 years ago
Sami Ljimari
Sami LjimariActive Contributor
asked in Developer platform and APIs
Redirect user to a certain widet

Miro supports a very usefull tool when sharing boards between users, where a user can send a link with a specified widget. When another user opens the board with this link, he gets automatically redirected to the position of this widget on the board. Is there a method for using this functionality via the miro SDK? I was looking into the viewport section of the documentation as it seemed like the most probable place to have this functionality, but didn’t find it there. Is this a part of the SDK and if so could someone link me to the documentation?

4
Anthony Roux
Mironeer
3 years ago
Kenneth Chen
Kenneth ChenBeginner
asked in Developer platform and APIs
Working on Web-plugin with multiple developers

I’m wondering if anyone has tips on developing a Miro web-plugin with more than one developers? I’m currently the only one working on the plugin so every time I want to work on it, I edit the web-plugin URL on the app settings page to a URL that points to my localhost.This is ok for now, but will get cumbersome when we bring more people in. Wondering if anyone has tips or want to share how they develop their plugins locally? Thank you!

3
Max Harper
3 years ago
R
RodhappiNew Here
asked in Developer platform and APIs
SDK + Typescript 👉 Unable to get Props like "Text" from Widget

Hi,I’ve just started to code a react app with typescript and I’m struggling with getting some props (ex. “Text”) from interfaces like IStickerWidget which extends IWidget. interface IWidget extends IWidgetNamespaces { readonly id: string readonly type: string readonly bounds: IBounds readonly groupId?: string readonly createdUserId: string readonly lastModifiedUserId: string }Here is the scenario: 1️⃣ I’m using the type declaration miro.d.ts. 2️⃣ Here is the snippet code where:1) I get the widgets selected (through the SDK IBoardSelectionCommands and its get() method),2) filter by type (STICKER) and3) then try to get again the specific widget, but through the get command from IBoardWidgetsCommands this time, as I thought the SDK was going to return an IStickerWidget type base on the filterby id.let selectedWidgets:SDK.IWidget[] = await miro.board.selection.get()let selectedStickers:Array&lt;SDK.IWidget&gt; = selectedWidgets.filter((widget) =&gt; widget.type ==

1
Anthony Roux
Mironeer
3 years ago
C
Constantinos PaphitisNew Here
posted in Developer platform and APIs
Create Overflow plugin for Miro

Looking for some guidance.  I am on an internship and have been asked to look into a way Miro can add flow diagram projects from Overflow.  What i want to do is to add projects from Overflow as you would do with the already available plugin for Adobe XD.  The idea is to provide collaboration on Overflow projects.  Any assistance to point me in the right direction will be greatly appreciated.

1
Anthony Roux
Mironeer
3 years ago
A
Addison JosephBeginner
posted in Developer platform and APIs
Create Widget: PostMan POST Call with Auth works. Fetch API Post call gets CORS error

Hello! I am able to provide my auth bearer token to a POST request containing the json to create a widget on my board via PostMan or the live test in the API Documentation.  However, running a local server / react app to call the fetch api using the same url and http headers/credentials results in CORS error. How am I to test the rest api for my app using the fetch api and running on localhost:XXXX?

9
A
3 years ago
A
anupam UJJWALNew Here
asked in Developer platform and APIs
Custom Notifications for MIRO board

I wan to show a custom message bar on top of all the board across my team. I can push a message on the board through web plugin using showNotification() method but if I use method, the notification disappears after few seconds.I want to ensure this message never disappears from the board and every time user open the board, this message is visible. What's the best way of achieving this.

1
Anthony Roux
Mironeer
3 years ago
U
UmapathyNew Here
asked in Developer platform and APIs
How to get your Client ID approved from Miro ?

Hi, I am working on integrating Miro to our web app, it has been said, we need to send our client ID to Miro to get approval, Please guide me through to which mail id, should this be sent ThanksUmapathy

1
Anthony Roux
Mironeer
3 years ago
Abhijeet Narvekar
Abhijeet NarvekarNew Here
posted in Developer platform and APIs
Web Plugin: Select Text In Widget

Hi,I am developing a web plugin for Miro. I want to select text inside a TextWidget. (As shown below)Couldn’t find any documentation if it possible to highlight text inside a widgetAny suggestions? Best,Abhijeet​​​​​​​

12
Marco Spinello
Mironeer
2 years ago
Matthias.Cullmann
Matthias.CullmannContributor
asked in Developer platform and APIs
Miro Marketplace App Permissions

When I install an new app from the marketplace ( in this case https://miro.com/marketplace/undraw/ ) it once says something like “this app will have permission to read and write all your boards”.is it normal for an app that “only” inserts clip art to a board to get these permissions? Shouldn’t it be the other way round: the app only provides the image and trusted Miro adds it to the board? How can I see / compare permissions of the apps I installed / on the marketplace? ie. how does https://miro.com/marketplace/unsplash/ with similar functionality behave? where can I find the EULA / privacy for apps on the miro marketplace? cf. Atlassian Marketplacehttps://www.atlassian.com/licensing/marketplace/termsofusehttps://www.atlassian.com/legal/privacy-policy#how-we-use-information-we-collect  

3
S
Mironeer
3 years ago
R
RamkumarBeginner
asked in Developer platform and APIs
How to retrieve user name from webplugin?

Is there any way to retrieve current user name with web plugin API, I see that there is an interface IUserInfo for user data, but not seeing how it can be fetched with API.

2
Maximilian Steverding
1 year ago
M
magno sousaBeginner
asked in Developer platform and APIs
Getting: Bad Request. Deserialization Error

Hi!I created an app and I’m trying to set the Web-plugin url but I’m getting the error “Bad request. Deserialization Error”. I tried changing the url to the one used by one app that is live now and I get the same. If I go back and open the app again the URL is saved but when I try to use the app in a board it’s not loading.Does someone have this issue or can help please?Thanks

5
M
3 years ago
W
Wender XavierBeginner
posted in Developer platform and APIs
WIDGETS_TRANSFORMATION_UPDATED event not working for type: LINE

Hello,I'm having an issue when listening for the WIDGETS_TRANSFORMATION_UPDATED event.All widgets trigger this event on change (shapes, text, stickers, etc) except for the LINES.If you update a line alone, it does not trigger this event, however, if you update together a line and a shape, it does show the line on the data array.Example of the event working for a TEXT widget. 

1
Anthony Roux
Mironeer
3 years ago
Sami Ljimari
Sami LjimariActive Contributor
asked in Developer platform and APIs
Use case for miro.board.widget.update() with multiple id's

Hi, I’m referring to this command https://developers.miro.com/docs/interface-iboardwidgetscommands#section-update I’m currently using it with single id’s but since it says there is a option to call it with multiple id’s I’d like to utilize this, since I’m exepriencing board freeze / syncing with higher volumes of requests made to the API. I can’t see a example on how to utilize with for example a array of id’s. What I have been using so far:await miro.board.widgets.update({                    "id" : widgetID2,                    "clientVisible" : false                }) Tried replacing my widgetID2 variable with a array but the API returned “Wrong argument passed to miro.board.widgets.update(widgets: {id: string; [index: string]: any}[]).”  I’m experiencing syncing times of up to 1 minute of the board when sending lets say 100 requests to the API to make 100 widgets invisible and want to prevent this ofcourse.

4
Sami Ljimari
3 years ago
Richard Watts-Seale
Richard Watts-SealeNew Here
asked in Developer platform and APIs
Export table data through the API

Is it possible to export table data, including the contents of each cell, using either the web SDK or REST API? I can see it is possible through the UI but I can’t figure out a way to do it programmatically.I can get back a list of all the widgets but there’s no explicit information about which cell they belong to. I guess it may be possible to calculate which cell each widget belongs to by using the table’s bounds and the widget’s co-ordinates but I haven’t looked into that yet. To give an example I would like to be able to programmatically determine that the “Whiskers” sticky belongs to the “Cats” column and “Names” row. 

3
Ronny Roeller
9 months ago
M
manavb1Beginner
posted in Developer platform and APIs
App with id not found

I beleive I am getting the above error because I am not authorizing the app to work with the Miro REST API. However, I am not sure how to do this as I was confused by the documentation on the website. I would appreciate any advice to go about fixing this.

3
Anthony Roux
Mironeer
3 years ago
Terms & Conditions