Developer platform and APIs

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

  • 867 Topics
  • 2,748 Replies

867 Topics

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
C
Clément PasekBeginner
asked in Developer platform and APIs

Question about anonymous boards

Hello everyone, I am using the embed miro whiteboard to enable users to create anonymous board. One of our customers ask us how Miro handle them. Are they deleted after an amount of days or are they stored forever ?I have searched in the documentation but I have found nothing about that. Thanks for your help :)

5
C
2 years ago
S
Sebastian HeblerBeginner
posted in Developer platform and APIs

Rate limit for SDK usage

Hi, the REST API rate limit and how to control it by using the responses is good described and works well (Even if being slow. But it is anyhow limited to 1000 widgets, but this is another question...). How can I control the rate limit for the SDK usage?The only statement I have found so far is: “The Miro SDK enforces rate limits on widget operations. Each operation (create, update, or delete) on one widget costs one point. The current rate limit is 10,000 points per minute, summed over all widgets, and overall web-plugins, executing in a single client.”Do I need to count on my own? Or are there any methods to check the remaining points or the time when the rate limit is replentished? Thanks and regards,Sebastian

5
Anthony Roux
Mironeer
2 years ago
J
Justin BarrettBeginner
asked in Developer platform and APIs

Problem updating a widget via the API: "Unsupported Media Type"

I’ve only been using the Miro API for a couple of hours, and I searched the board for a solution to this problem, but nothing came up.I’m trying to use the API to update sticky notes with new text from an Airtable database. My test code in an Airtable scripting block is successful in retrieving all widgets on a board and isolating those widgets that are sticky notes, but I’ve hit a snag when attempting to update them. The API docs only show a partial code example for updating a widget, and while I can successfully update one of these sticky notes interactively using the “Try It” button in the docs, my code always returns a 415 error: “Unsupported Media Type”. I’m only trying to update the widget text, so I don’t know why this media-type error is coming back.Here’s how I’m setting up the fetch options:The docs list a “RAW_BODY” body parameter, but the code example doesn’t show where this should go. I’ve tried adding an outer object with that parameter wrapped around the main object, but

3
Anthony Roux
Mironeer
2 years ago
M
MohsenBeginner
asked in Developer platform and APIs

Pass a long string to modal

Dear miro team,I have to pass a long string to a modal when it’s being open. The app is supposed to run at client side only, and wrigin the string to board, then reading it from the modal is not a good option.This is the sudo code:`miro.board.ui.openModal('./editor.html', { dataToBePassedToModal: text })`Is that possible?

3
M
2 years ago
C
Constructive RealitiesBeginner
asked in Developer platform and APIs

Way to import Youtube Playlist automatically?

Hi I would like to import a youtube playlist into a board.  Is there a way to do this?  or would i need to use a greasemonkey script or the API to do this?   If the API, any tips on relevant info to try would be appreciated.

2
C
2 years ago
J
janardhanBeginner
posted in Developer platform and APIs

Not able to call rest api from asp.net core web api

I am calling REST api from my web api which is implemented using .net core web api. But i am getting The SSL connection could not be established and “Authentication failed because the remote party sent a TLS alert: 'HandshakeFailure'.” message. Please help me why i am getting this message.Please help me how to establish trust between Miro api and my custom web api.

1
Anthony Roux
Mironeer
2 years ago
J
JohnW12Beginner
asked in Developer platform and APIs

Display panel to multiple users

Hi,I am experimenting with miro’s webplugins. I’d like to display a panel to all people currently viewing the board, similar to how the voting plugin does it. How can I do this? I’d also like to synchronize data between all of the people currently using the board. Is there some sort of data store?Regards,John

7
J
2 years ago
O
omar abdelazizBeginner
asked in Developer platform and APIs

Editable boards for not registered users

i am in team plan, i am using board picker to embed miro into my website and i am embeding Editable boards for not registered users but the created board is not editable it’s in can comment state

8
O
3 years ago
M
MohsenBeginner
asked in Developer platform and APIs

Revsersing the direction of lines does not switch the line.startWidgetId and line.endWidgetId

Steps to reproduce :Connect to widgets using an arrow line. Click on the line and reverse it from the menuon top.Expected behaviour:Line.endWidgetId == the id of widget the arrow line points to. AndLine.startWidgetId == the id of the widget the arrow starts from. Actual behavior :Line.startWidgetId == the id of widget the arrow line points to. AndLine.endWidgetId == the id of the widget the arrow starts from.

2
Max Harper
3 years ago
Markus Smet
Markus SmetMiro Hero
posted in Developer platform and APIs

My experience of developing a Miro app

We have just finished a plugin for Miro that allows a user to “syncronise” widget content. Change one widget in a sync group and the change is propagated across all widgets in that group. The app is called CarbonCopy and we hope to see it on the Marketplace soon. Here’s a loom for you to get a preview.Here’s a summary of our encountered challenges.identified workarounds and challenges in MiroMissing widget update capabilities when widget changes: https://community.miro.com/developer-platform-forum-57/identify-changes-in-miro-widget-2845 Image meta-data updates aren’t working, which means we were unable to implement image widgets: https://community.miro.com/developer-platform-forum-57/image-widget-doesn-t-allow-metadata-update-2894 Buttons in the WidgetContextMenu iframe implementation cause slightly laggy widget performance when the widget has a plugin button in the widget’s extension menu. Setting the button position in the WidgetContextMenu is based on setting a numerical priority wh

11
Max Harper
3 years ago
Terms & Conditions