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>

  • 1,012 Topics
  • 3,213 Replies
1010 Topics
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?

9539
A
Vladislav Khodchenkov
Vladislav KhodchenkovBeginner
posted in Developer platform and APIs
Custom Plugin - HideMan

 Hello everyone, this is the same StickerMan team. Recently, we thought, but Miro is used not only by designers, managers of large and small companies. A large whiteboard on the Internet brings together many people with different professions, from a designer of a big company to one person working as a freelancer. We met a person who uses the whiteboard. She works as a foreign language tutor; with the help of Miro, she conducts her classes remotely. Such lessons are quite interactive and exciting. After a short interview, we identified some wishes that would help teachers and tutors organize lessons. For example, the function of hiding information on a sticker or shape, the teacher can hide some information up to a certain point (a hint, an answer, maybe even something in the form of a surprise). In such classes, they are now trying to hide information by covering them with stickers or removing them somewhere far away. Our solution will facilitate their work.Hidden information on sticke

11546
P
Laflys
LaflysContributor
asked in Developer platform and APIs
APP Manager and Authorization problems

Hello,New problem with plugin authorization, we are using token authentication to get around the webplugin problem with the new method.The plugin constantly asks to be authorised, and the error below appears every time it loads.But a bigger problem, any action done in the APP Manager results in an error :The problem persists since yesterday, do you have any idea of how to fix it? Thank you,Regards, 

3104
Laflys
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

1515
M
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.

1664
Sami Ljimari
R
Reuben Su'aBeginner
asked in Developer platform and APIs
Can't create widget using miro.board.widgets.create(). TypeError: Cannot read property 'name' of undefined

Hello, I am trying to programmatically populate a board with predefined shape widgets. N.B i can successfully create a frame widget, but not its children and attempting to separately render child widgets hasn’t worked for me either. Please see stack trace below, I suspect that the error is originating from the Miro Web Plugin SDK.Looking through the documentation, I can’t see a requirement for a ‘name’ property for a widget.. tested and adding a name property to the json object results in the same error.Please, Let me knowRegards, RTypeError: Cannot read property 'name' of undefined    at Function.t.getName (Board.4b1e51e782d99f6d574d.js:2)    at t.setFontSizeOfStyle (Board.4b1e51e782d99f6d574d.js:2)    at n.setWidgetData (Board.4b1e51e782d99f6d574d.js:2)    at n.setJsonData (Board.4b1e51e782d99f6d574d.js:2)    at n.setData (Board.4b1e51e782d99f6d574d.js:2)    at new n (Board.4b1e51e782d99f6d574d.js:2)    at create (Board.4b1e51e782d99f6d574d.js:2)    at Object.e.create (Board.4b1e51e7

2264
R
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. 

821
Anthony Roux
Mironeer
M
manavb1Beginner
asked in Developer platform and APIs
Type 'undefined' is not assignable to type 'Promise'.

I am trying to add a button to the context menu for widgets, here is the code: miro.onReady(async (): Promise&lt;void&gt; =&gt; { miro.initialize({ extensionPoints: { getWidgetMenuItems: (widgets) =&gt; { if (widgets[0]['type'] === 'CARD') return [{ tooltip: 'Estimate', svgIcon: '&lt;circle cx="12" cy="12" r="9" fill="none" fill-rule="evenodd" stroke="currentColor" stroke-width="2"/&gt;', onClick: async (widgets) =&gt; { await jiraCard() } }] } }, });})Unfortunately, this gives me the error       TS2322: Type '(widgets: IWidget[]) =&gt; { tooltip: string; svgIcon: string; onClick: (widgets: any) =&gt; Promise&lt;void&gt;; }[] | undefined' is not assignable to type '(widgets: IWidget[], editMode: boolean) =&gt; Promise&lt;IWi

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

2073
Anthony Roux
Mironeer
P
PolinaNew Here
posted in Developer platform and APIs
Adding Tags to the cards via API

Hi Miro Team,I was looking to create an app that will allow to create cards automatically from a CSV file. And looking at the API docs I saw that card got only these fields: title, desc, date, assignee. Can Tag field be added to a cardusing the API?

2281
Max Harper
R
RamkumarBeginner
posted in Developer platform and APIs
Create image widget with Data URL

Hi, Is it possible to create image widget with data URL such as data:image/jpeg;base64,/9j/4…When I attempt to do so it throws error Error: 'url' field is required for ImageWidget Regards,Ram

3721
Max Harper
M
manavb1Beginner
asked in Developer platform and APIs
restricting getWidgetContextMenu

Is there a way to restrict the widgets that getWidgetContextMenu applies to? I’m adding a new button, and I’d only like this button to show up for kanban. 

583
Max Harper
M
manavb1Beginner
posted in Developer platform and APIs
Error while command execution: Method 'board.selection.get' requires scope 'boards:read'

Resolved.

290
M
Falk Kühnel
Falk KühnelActive Contributor
asked in Developer platform and APIs
How can i find out, if one widget is in front of another?

Hi! Is there a way to find out, if a widget is in front of another widget? ThanksFalk

411
Anthony Roux
Mironeer
P
Phil WolffBeginner
posted in Developer platform and APIs
If This Then Miro. Deeper Density. and Vasting Up.

Right now Miro seems mostly about people starting things. I’m sure Miro has a frequency distribution showing how many boards people make. Over time, how many times they come back, factors driving repeat usage, tipping point between trying a few boards and being hooked on Miro, factors driving sharing and collaboration. IFTTM. I want to know about scale and how miro will help with scale. With APIs, other tools can generate boards. Like the manager who had more than a thousand pdfs for his team to annotate. People who meet could connect miro to calendaring and conferencing apps to trigger templated boards and automatically invite the right folks to contribute. Software developers might have a project’s issues not just added to a an existing kanban but start a scorecard board for each issue for a team to weigh in. There might be thousands of boards per worker, most generated automatically to lay the ground for further work.  Overwhelm ahead. But nothing in the user experience suggests any

7874
Sita Magnuson
P
Pranav PatelBeginner
posted in Developer platform and APIs
Miro onReady() function is not working

I am trying to integrate miro in my react app. And I am currently facing these errors,“SDK Loaded” message is being printed on the console, but miro.onReady() function is not getting called. And if I try to call miro.isAuthorized() or miro.requestAuthorization(), then it’s showing me error (“is not a funtion” for both), even if “miro” as a variable is defined. From one conversation in the community, I found that we can put the ReactDOM.render function inside the miro.onReady function, but now even “SDK Loaded” is not being printed, and React app is also not being rendered.

3589
Anthony Roux
Mironeer
A
Alex ZakBeginner
asked in Developer platform and APIs
Create Miro Objects via API

Hello, I am at the  beginning of development project to populate Miro board using API. Checking API reference at https://developers.miro.com/reference I can’t find enough details for what I need.My requirements are:For a board &lt;xxx&gt;Create/update card widgetsI found Get Current User Boards API which returns all boards current user has access to. I can then loop through to find the board I need and start adding/updating cards.Card widget JSON does have tags field. Is there any way to add tags via API?Are there any examples of end-to-end similar functionality (including authentication)?

17332
Anthony Roux
Mironeer
A
Alyan SanievBeginner
asked in Developer platform and APIs
admin_rules _ access token

Hi.I got an access token to use Api for collecting Audit logs.My account has the role of company administrator.If my account is deprived of the administrator role, will the token work? for getting logs?Thank you.

521
Anthony Roux
Mironeer
U
uxmccauleyBeginner
asked in Developer platform and APIs
baackgroundColor property for miro.board.widgets.create method

I have the following code to recursively create a custom sticky widget from a CSV inside a web plugin. miro.board.widgets.create({ "type": "sticker", "style": { "backgroundColor": "#ea94bb", "fontFamily": "Bangers", "textAlign": "right" }, "text": data[i][filter], "x": ( 220 * horizontal ), "y": ( 220 * vertical ) })Regardless of what color I substitute in the backgroundColor property, I cannot get the stickies to generate as that color. They always get created yellow. I have run this same method with the “shape” widget and I get the correct specified background color. It there some nuanced approach to coloring stickers that I am just overlooking? I have been through the API documentation at least two dozen times. 

1887
B
A
Alyan SanievBeginner
posted in Developer platform and APIs
I don't understand the "Miro REST API" description

Hi.Сan you explain the meanings of the "Miro REST API" events, please? For example:account_created account_default_project_sharing_settings_changed account_invitation_settings_changed account_external_collaborators_enabled account_integration_settings_changed user_invited_to_account I think “account = team”, right?I want to understand it before using API and getting logs.Thanks!p.s. Можно на русском.

1552
A
M
Manav BhatiaNew Here
posted in Developer platform and APIs
getWidgetMenu loses default icons

Hello, I am trying to add a custom icon to the menu for a given widget, this is the code for doing so:function jiraCard() {  miro.board.ui.openModal('modal.html',{ width: 400, height: 600 }).then(() =&gt; {    miro.showNotification("modal closed");  });}miro.onReady(() =&gt; {  miro.initialize({    extensionPoints:{      getWidgetMenuItems: (widgets) =&gt; {        return{          tooltip: 'Estimate',          svgIcon: '&lt;circle cx="12" cy="12" r="9" fill="none" fill-rule="evenodd" stroke="currentColor"       stroke-width="2"/&gt;',          onClick: async (widgets) =&gt; {            jiraCard()          }        }     }   } })})The problem is that this code makes all the default widgets disappear, so that the only button the menu is the custom widget that I am defining. Is there anyway to prevent this problem?

774
Falk Kühnel
Kenneth Chen
Kenneth ChenBeginner
posted in Developer platform and APIs
How to enable thumbnail for iframe widget

Hi!I’m wondering if there’s a way to add thumbnail for my custom iframe code? I noticed that some popular embed providers like Youtube and Soundcloud have thumbnails, but if would be cool if I can somehow enable thumbnails (preferably using some kind of API) for my own iframe.How come some iframes have thumbnails and some don’t? Does Miro use Embed.ly behind the scene to get extra data to display?

4642
Kenneth Chen
W
Wender XavierBeginner
asked in Developer platform and APIs
Update react state inside miro listener doubles with each request

I'm developing a webapp where I listen to the selected event on any board component and update the state on the react component, however, after each request, the listener is being triggered 2x compared to the last selection event.The code is as follows:function myComponent() { const [counter, updateCounter] = useState(0); miro.onReady(() =&gt; { miro.addListener("SELECTION_UPDATED", () =&gt; { console.log("selection updated triggered"); updateCounter((counter) =&gt; counter + 1); }) }) return ( &lt;div&gt;{counter}&lt;/div&gt; )} The counter values is doubling the values like follow: 0, 1, 3, 7, 15, 31…Can someone help me understand what's going on? 

3002
W
A
annie.maria_extBeginner
asked in Developer platform and APIs
Miro API to delete a user from a board

I need to sync between access in MS teams and Miro. My use case is similar to  this link : Add and remove users (miro.com), but the endpoints are deprecated now.I just wanted to check, if there an endpoint to remove the users from a board, if so could I please get the details of that .

2081
Anthony Roux
Mironeer
D
Dustin BuetlerNew Here
asked in Developer platform and APIs
block text work-around

Dear All As far as i know is it only possible to choose from three kinds of text-block styles. I was wondering if there is a work-around to manually make block texts (the vey square ones), like the ones you can select in Word for instance.  Would be very Thankful for any advice,Dustin

3271
mlanders
Terms & Conditions