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>

  • 997 Topics
  • 3,156 Replies
997 Topics
K
kirillkirillkirillBeginner
posted in Developer platform and APIs
Unknown error when creating an app

When creating an app and getting a token for our current team I get this error.If I try token for DevTeam everything is ok but when I try it for existing one I get an error. What’s the problem? 

4091
Anthony Roux
Mironeer
3 years ago
N
nRthNew Here
asked in Developer platform and APIs
Can I show+edit widget ids+metadata within Miro?

I am trying to use Integromat to move data between Airtable and Miro. The hope is that I can do this without needing to write any code, which would mean my team can also setup their own workflows without needing any code.The idea is to make a Miro board a template and then copy it and put some data into the board at specific locations. My team members would make and modify the template, and I need some way for them to identify where they want what data plugged in. the API requires me to know the precise widget ID of the widget that I want to update. I cannot see the id in the board, and I assume each copy of the template would create a separate widget id so I can’t rely on any particular one.I see that it’s possible to put some metadata on a widget (again programmatically) and then I guess I would list all widgets and filter for those that have the metadata I want.My question is - is there some visual way to change the metadata of the widget from within miro, that I can then use within

2731
Max Harper
3 years ago
A
Afshin HoseiniBeginner
asked in Developer platform and APIs
Change the mouse pointer

Hi,Is it possible to somehow change the the mouse pointer’s shape when user clicks on our app’s button on toolbar?Imagine I want to implement the same behavior as comment button in tool bar using  web plugins. Like this gif: https://share.getcloudapp.com/jkuLODOJ

12602
S
3 years ago
M
MonitorNew Here
asked in Developer platform and APIs
How can I create rest api app and use it in enterprise account?

Hi. I have application tested in my personal account in dev-team. But then i signed to enterprise account, I can’t create a dev-team and create any rest api configuration. I received a message during dev team creation - Domain users are not allowed to create any account outside of their domain organization.Domain admin is ready to provide any rights, but how can it be done? 

1971
Rich Moore
Mironeer
3 years ago
L
Loize DalcoNew Here
posted in Developer platform and APIs
Figma integration

There’s a way besides Figmiro that we can connect Figma with Miro? I ask because Figmiro is great, but we use a SSO connection in our softwares in my company and it’s not possible to connect it from there. If anyone has a trouble with that could give us a help?  I’ll ask also the developer on GIthub when it would be avaiable, but there’s something coming from Miro team? 

13934
Anthony Roux
Mironeer
3 years ago
B
Bogdan KosarevNew Here
posted in Developer platform and APIs
Web Plugin not working

Hi all!I made a simple web-plugin and all was fine. But some time ago it stops working. In console log I see such messages: Access to fetch at 'https://miro.com/api/v1/users/&lt;id&gt;' from origin '&lt;my server host&gt;' has been blocked by CORS policy: No 'Access-Control-Allow-Origin' header is present on the requested resource. If an opaque response serves your needs, set the request's mode to 'no-cors' to fetch the resource with CORS disabled.I definitely haven't made any changes to either the plugin code or my server settings. Can you tell me if there have been any changes in Miro in this regard?Thanks!

941
Anthony Roux
Mironeer
3 years ago
R
RamBeginner
asked in Developer platform and APIs
Export the board from iframe

Hey @allWe use the paid Miro api on our site. The board is very nice, is working good . Now we have created the export button on our site. If you click on the button, the current Miro board is download .. How to do it?Is anything possible for that?How do we change our code? Note: This is an external function. We do not use the default export option inside the board Thanks,G Ramkumar

1821
Anthony Roux
Mironeer
3 years ago
R
RamBeginner
asked in Developer platform and APIs
Whiteboard Integration on our site

 Hi.., How to use our site for Miro whiteboard. We looked at the API document, but are still confused. Is it possible to integrate with the Miro whiteboard on our site?ORIf there is any paid version, please send details and how to integrate the Miro whiteboard application into my Laravel code? Thanks,G. Ramkumar

4411
Anthony Roux
Mironeer
3 years ago
M
Maxim ZaykovNew Here
posted in Developer platform and APIs
Create Board without registration error

Hi! I’m trying to use the “Create Board without registration” button but it doesn’t work. Maybe, something wrong with JWT integration. Any ideas? &lt;script language="JavaScript" type="text/javascript" src="https://kjur.github.io/jsrsasign/jsrsasign-latest-all-min.js"&gt;&lt;/script&gt;&lt;script type="text/javascript"&gt;var oHeader = {alg: 'HS256', typ: 'JWT'};// Payloadvar oPayload = {};var tNow = KJUR.jws.IntDate.get('now');var tEnd = KJUR.jws.IntDate.get('now + 1day');oPayload.iss = "CLIENT_ID";oPayload.nbf = tNow;oPayload.iat = tNow;oPayload.exp = tEnd;// Sign JWT, password=616161var sHeader = JSON.stringify(oHeader);var sPayload = JSON.stringify(oPayload);var sJWT = KJUR.jws.JWS.sign("HS256", sHeader, sPayload, "CLIENT_SECRET");&lt;/script&gt;&lt;script&gt;function onClick() { console.log(sJWT); miroBoardsPicker.open({ clientId: 'CLIENT_ID', // 1) Put your 'clientId' here. action: 'access-link', allowCreateAnonymousBoards: true, //2) Enable this option getT

1242
M
3 years ago
S
SimonSabinBeginner
asked in Developer platform and APIs
Is there any plan to add Comments and Tags to the API

I’d love to access tags and comments from the API. Is that possible. Seems nuts to have to implement an API to duplicate that data into customfields/metadata

7462
A
3 years ago
T
Taylor MasonBeginner
asked in Developer platform and APIs
Custom Web Plugin not working

Hi, my team and I have created a custom web plugin which was working properly. When a new team member was added, he could see the web plugin icon but the custom feature didn’t work at all. This is what we get as an error: “Uncaught (in promise) Error while command execution: Method 'board.widgets.get' requires scope 'boards:read'”.  We have already allowed the “board:read” permission for our app. So I tried to reinstall the app but it seems we need to authorize the app. So I tried to authorize the plugin but I and my team get this message.We have subscribed for a team account and I am not sure how can we get this plugin to work again. I also tried to create a new app but this same message appears every time.  Am I missing out on anything? Please help me out here! Regards,Taylor

1193
Anthony Roux
Mironeer
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. 

501
Anthony Roux
Mironeer
3 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?

2454
Anthony Roux
Mironeer
3 years ago
H
Hassan KumailNew Here
posted in Developer platform and APIs
How can you Show/Hide a widget permanently using Miro SDK?

Hi everyone. I know that you can show/hide a widget for current user using clientVisible property as shown here . But what I want is to be able to hide/show a group of widgets for all users. For example, I have a group of images stacked together on top of each other. The images are grouped together in miro.What I want to do is to be able to click on an image, so that the upper image gets hidden and lower image gets show and vice versa.What I have been able to achieve so far is to hide/show “text groups” using Miro SDK and using metadata property to store the states.FOR EXAMPLE: On first click, bottom text showsOn second click, bottom text hides, upper text shows I am using custom plugin for this. I want to do this for images instead of text but I guess metadata on images is not working. Any updates? So far, it works fine on other widgets except image widgets which doesn’t throw any error but it gets stuck on updating.let update = await miro.board.widgets.update(ids)Any directions how c

2472
H
3 years ago
Kenneth Chen
Kenneth ChenBeginner
asked in Developer platform and APIs
Listen to childrenId change in frames

Hello!I’m currently working on a plugin that tries to simulate some type of real time update behavior. I.e. when I add, modify, or delete some sticky notes inside a frame, it will trigger some action somewhere else. To all the Miro and JS experts out there: I’m wondering if there’s a way to listen for a change in the frame’s children and react to it?The only way I can think of is leveraging the existing Miro SDK listeners so that every time a sticky note is created, it will check every relevant frame and see if the sticky note is inside one of them. I’m just a little concerned that this method won’t scale well.Thank you in advance for your answers!

1201
Anthony Roux
Mironeer
3 years ago
D
Dominic NguyenNew Here
asked in Developer platform and APIs
Image Plugin API

Hello, I’m trying to upload an image widget via the REST api. I can see some references to https://miro.com/api/v1/boards/&lt;boardId&gt;/integrations/imageplugin using a hash authentication, but nothing on the documentation. Is there an equivalent in the published API? Many thanks

2351
Max Harper
3 years ago
A
Anton AbramovNew Here
asked in Developer platform and APIs
Boards Picker Component Does not work on localhost

I am trying to execute Boards Picker API locally .code:clientId : 3074457360836196477but getting Sorry, integration is unavailable.Error. Account is not a partner. Reason is accountIsNotPlatformPartnerI also added localhost and 127.0.0.1 in Boards Picker domains list at app dashboard.But did not help.

1101
Anthony Roux
Mironeer
3 years ago
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

2722
Sami Ljimari
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

4947
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?

241
Anthony Roux
Mironeer
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

1921
Anthony Roux
Mironeer
3 years ago
R
RamkumarBeginner
posted in Developer platform and APIs
Bug - Shape widget conversion issue.

Hello, When shape widget is transformed into sticky, card or a different widget type it looses the original ID as well as metadata stored in them. Ideally conversion should retain all attributes but it seems that’s not happening. Could this be considered as bug and fixed?

572
Marina
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. 

2245
Sami Ljimari
3 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  

2403
S
Mironeer
3 years ago
E
esenNew Here
asked in Developer platform and APIs
LTI integration with a LMS

Hello, has anyone integrated MIRO with a learning management system so MIRO whiteboards can be used within a learning management system? Thanks!  

32373
P
3 years ago
Terms & Conditions