Developer platform and APIs

Discuss everything related to Miro API, SDK, embedding and Miro Platform apps development. See documentation at developers.miro.com

  • 703 Topics
  • 2,324 Replies

703 Topics

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
1 year 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
1 year ago
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

4
R
2 years ago
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<void> => { miro.initialize({ extensionPoints: { getWidgetMenuItems: (widgets) => { if (widgets[0]['type'] === 'CARD') return [{ tooltip: 'Estimate', svgIcon: '<circle cx="12" cy="12" r="9" fill="none" fill-rule="evenodd" stroke="currentColor" stroke-width="2"/>', onClick: async (widgets) => { await jiraCard() } }] } }, });})Unfortunately, this gives me the error       TS2322: Type '(widgets: IWidget[]) => { tooltip: string; svgIcon: string; onClick: (widgets: any) => Promise<void>; }[] | undefined' is not assignable to type '(widgets: IWidget[], editMode: boolean) => Promise<IWi

1
Anthony Roux
Mironeer
2 years ago
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?

1
Max Harper
2 years ago
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

1
Max Harper
2 years ago
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. 

3
Max Harper
2 years ago
M
manavb1Beginner
posted in Developer platform and APIs

Error while command execution: Method 'board.selection.get' requires scope 'boards:read'

Resolved.

0
M
2 years ago
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

1
Anthony Roux
Mironeer
2 years ago
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

4
Sita Magnuson
2 years ago
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(() => {    miro.showNotification("modal closed");  });}miro.onReady(() => {  miro.initialize({    extensionPoints:{      getWidgetMenuItems: (widgets) => {        return{          tooltip: 'Estimate',          svgIcon: '<circle cx="12" cy="12" r="9" fill="none" fill-rule="evenodd" stroke="currentColor"       stroke-width="2"/>',          onClick: async (widgets) => {            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?

4
Falk Kühnel
2 years ago
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 <xxx>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)?

2
Anthony Roux
Mironeer
2 years ago
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.

1
Anthony Roux
Mironeer
2 years ago
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. 

5
Anthony Roux
Mironeer
2 years ago
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. Можно на русском.

2
A
2 years ago
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?

2
Kenneth Chen
2 years ago
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(() => { miro.addListener("SELECTION_UPDATED", () => { console.log("selection updated triggered"); updateCounter((counter) => counter + 1); }) }) return ( <div>{counter}</div> )} The counter values is doubling the values like follow: 0, 1, 3, 7, 15, 31…Can someone help me understand what's going on? 

2
W
2 years ago
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 .

1
Anthony Roux
Mironeer
2 years ago
R
Ravi KishanNew Here
posted in Developer platform and APIs

Regarding User management in API

Does miro provide user management through API.I found i can Invite a user and read a user.But didn’t find anything for updating and deleting.  

1
Anthony Roux
Mironeer
2 years ago
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

1
mlanders
2 years ago
Falk Kühnel
Falk KühnelActive Contributor
posted in Developer platform and APIs

Installing a web plugin app does not work

Hi! I am trying to install a plugin for a Team as described in https://developers.miro.com/docs/share_your_app_wp, I reach the selection page, i click on install, i get redirected to the expected html page, but the plugin does not show up. It used to do that, when i first did that several weeks ago. What am i doing wrong? Any clues? ThanksFalk 

5
Falk Kühnel
2 years ago
P
Pol.clmBeginner
asked in Developer platform and APIs

boardPicker Integration - Server Token Response?

I’m trying to implement the boardPicker with anonymous approach but i’m getting 401 from: i have and endpoint to retrieve the token and is returning it with next format: How i know what format miro api is wating for?Thanks!​​​​​​​

3
P
2 years ago
J
janardhanBeginner
asked in Developer platform and APIs

How to get currentUser email using Miro object

I want to get current user email address on Miro board load using Miro object. Please help me which object we have to use to get current user email.

3
Anthony Roux
Mironeer
2 years ago
J
janardhanBeginner
asked in Developer platform and APIs

How to get ICONs to add icons to bottomBar web plugins

I am embedding  icons to Miro Board using bottomBar extension, i am able to add Circle icon but i want to add help icon ,  book icons and other icons.Please let me know how to get the html of icons.   

2
Anthony Roux
Mironeer
2 years ago
U
Uday CherukuriNew Here
asked in Developer platform and APIs

Using REST API to create Widgets, can they be attached to existing widget context?

For some context, I’m looking to connect another one of our applications to Miro to populate a Kanboard with Project data. I’m accomplishing the creation and description portion of this idea programatically, but needing to put the idea into the correct swimlane that indicates each individual projects progress manually. Also unable to add tags programatically which contains project tag data.  I’m wondering if the kanban board will ever get support to add cards to an existing kanboard via api, and also interested in when adding tags to cards will be a supported feature. 

2
A
2 years ago
Terms & Conditions