Developer platform and APIs

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

  • 704 Topics
  • 2,334 Replies

704 Topics

Sami Ljimari
Sami LjimariActive Contributor
asked in Developer platform and APIs

Miro widget metadata not complete?

Hi, I’m working on a custom miro extension using javascript. It will function as a “layer” extension, something like photoshop uses to layer different edits on a photo. Miro board natively supports Bring to front and Send to back. I’m looking to apply this function to the whole layer, so for example if there were 10 widgets in a specific layer and a user brings that layer to front all widgets will be moved to front. I tried digging in miro board widget metadata but can’t find any attribute of a widget that represents bring to front or bring to back. In CSS this could be referred to as “z-index” of a object or element. Thanks for any help, alternatively is there any way to contact someone from the dev team and ask them?

1
Daniela Gavidia
Mironeer
2 years ago
B
Ben MortBeginner
asked in Developer platform and APIs

Is there any way to change a card widget fill color through the REST or Web APIs?

I would like to be able to change the background fill colour for card widgets though the API (REST or otherwise) but have not been able to find a way of doing this? Am I just being blind or is this not exposed? I can do this via the web UI with the slider at the top of the option to change the card color.

5
T
1 year ago
K
Kirill RyadchenkoMiro Hero
asked in Developer platform and APIs

Where to find "your_app_id"

MIRO reference explains how to create a widget with metadatahttps://developers.miro.com/reference#application-metadata PATCH https://api.miro.com/v1/boards/{boardKey}/widgets/{widgetId}Content-Type: application/jsonAuthorization: Bearer *****{ "title": "", "metadata": { "{your_app_id}": { "changed": "data" } }}In metadata parameters I need to insert “your_app_id”.Where can I find my app id?

1
Boris Borodyansky
Mironeer
2 years ago
Steve Appling
Steve ApplingBeginner
posted in Developer platform and APIs

How should I post requests for developer features?

I just want to ensure that I am using the community forum correctly.  I tried to post a suggestion for a new feature for the REST API.  I marked it as an idea, but then I couldn’t find my post under the developer platform forum.  It went under an innovation section. Is that how I should have handled an API request?

1
Marina
Mironeer
2 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

2
A
1 year ago
S
Stefan_New Here
asked in Developer platform and APIs

Everything working from localhost except image widget creation.

Hi, I’m poking around the webapp- and rest-api in order to figure out if its possible to bridge Shotgun ↔ Miro for internal needs.Currently, everyting works fine with a localhost dev-server + self-signed SSL-certificates, drawer with images, javascript executing, the whole shebang. However, when trying to replicate the last part of the drag-and-drop demo and running the following code: miro.board.widgets.create({‘type’: ‘image’, url: “https://localhost.*”, x:x, y:y}) The board complains that I’ve put in the wrong address, but clicking the link in source takes me to the correct image. So I'm assuming that it looks from the ‘outside’ and therefor can’t see my dev-server. Since everything else has worked fine on local up till now I’m wondering if this can be rectified or if I’ve missed something? Running this on an internal server is an hard requirement, the service as a whole (miro) has been vetted as safe so a possible work-around would be to have them hosted by them, with the caveat th

1
Ahmed El Gabri
Mironeer
2 years ago
J
Justin FenechBeginner
asked in Developer platform and APIs

Custom menu on Widget Bar

Forgive me for using incorrect terminology as I have just started digging into this.I understand how to add a custom icon to the widget menu bar and am able to show a modal, however I would like to instead make my icon display a “dropdown-like” menu instead. Much like the functionality of the tags or assignee dropdowns. Is this possible?Thanks,Justin

4
T
4 months ago
tkat0
tkat0New Here
asked in Developer platform and APIs

Unable to get CARD metadata with REST API

Hi community. I want to develop an application that use card metadata.Unfortunately, I can add metadata to the card with JavaScript SDK, but I can’t get it with REST API.Do you know why? Reproduction procedure(0) Create Applicationhttps://developers.miro.com/docs/getting-started(1) Create a card with SDKawait miro.board.widgets.create({ type: "card", text: "test card", metadata: { [appId]: { hoge: true, }, }})(2) Get the card with REST APIcurl --request GET \ --url https://api.miro.com/v1/boards/${board_id}/widgets/${widget_id}\ --header 'authorization: Bearer ${token}'→ No metadata Thank you.

1
Daniela Gavidia
Mironeer
2 years ago
Becky
BeckyBeginner
posted in Developer platform and APIs

Understanding custom web widget sharing with other users

Hi Miro team,I’m currently working on a research project exploring the ways to enhance the functionality of Miro boards for SLT practitioners.I’ve been trying out some of the sample code for making custom web widgets with some success. I’ve been able to make several widgets that work in the Dev Team environment and have also been able to publish them to other boards. However, the other users of the boards are unable to use them. I’ve read all the documentation online, but am still unclear about the steps to make my widgets work for others.My code is published via GitHub pages at: https://newcastlerse.github.io/miroI’ve recreated the 'implicit-flow-example' from the miroapp/app-examples repo. This given as an example on the page: https://developers.miro.com/docs/how-to-start#section-3-install-your-web-plugin-to-any-miro-user. On the Dev Team board, I get a pop-up that I click to authorise the widget and it clears the board of all content. My understanding of the implicit-flow-example is

14
Max Harper
2 years ago
Cozy Juicy Real
Cozy Juicy RealBeginner
posted in Developer platform and APIs

Is it possible to batch deletion/move/duplicate/share boards?

Hello Developer Community! I hope you all had a good weekend. I’m messaging today because I use Miro to facilitate events and game experiences and frequently need to create 20+ boards from a template, make them all ‘editable’ to guests, copy their links and delete them after use. I would LOVE to see the dashboard with these kinds of batch commands - just like you would see in an email inbox. Since this isn’t the case, I’m exploring other ways… is any of this possible through API? If so, how? Thanking you in advance!Sophia  

1
Viktor Dolhishev
Mironeer
2 years ago
T
TarangContributor
posted in Developer platform and APIs

Creating Templates with Inheritance of Locked attributes of Components

I have created Miro boards that I expect to use in a number of events and so I export the board as a template so I can source it to instantiate my board for other events.The problem is that all the locked attributes for components in the original source are not preserved in the Template and its tedious to have to reassert the locks every time. I was expecting export as template will preserve all attributes in the template, this includes lock attribute. Why isn’t this the case?

3
Max Harper
1 year ago
V
vaibhav chadhaBeginner
posted in Developer platform and APIs

Integration with Onenote

Hi I want integration with onenote. What I want to achieve is that every time I create a new page within a specific notebook it should lead to creating a new child branch within a node. This way whenever I have new counter parties added ( for each new page entry) I create a new child node real time. Is this possible to achieve?

1
S
Mironeer
2 years ago
M
Mike HatchBeginner
asked in Developer platform and APIs

Using clipboard from web-plugin

I’m trying to create a web-plugin component that uses a library component (miro.board.ui.openLibrary) that tries to capture events (change or paste) events so the user can paste data into the component.  In the event, I am trying to access navigator.clipboard.readText().  It fails on this line with the following error in chrome: Uncaught (in promise) DOMException: Disabled in this document by Feature Policy.It would seem that access to the clipboard is not allowed within a web-plugin? If it is allowed, is there something specific I need to do to enable it?

3
M
2 years ago
S
saifisBeginner
asked in Developer platform and APIs

Can you lock objects made via API when they are created?

I want to lock some objects when having a set of objects created since they act as background objects, I know you can do this on board, but can it be done when created via miro.board.widgets.create?

3
V
9 months ago
C
Carmen GraverBeginner
asked in Developer platform and APIs

Can't Update Cards

I’ve recently run into problems updating cards on my boards.  Unable to move cards or to update them unless I close Miro and then reopen.  

5
Kiron Bondale
2 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? 

4
Anthony Roux
Mironeer
1 year ago
L
Ladd JonesBeginner
posted in Developer platform and APIs

Capturing node links in an embedded page

I am using the brain map template of miro and loving it.  I have the map embedded in my website.  The different nodes in my mind map are titles and currently I have it so that each node links to a completely new html page on my website.  What I mean is that if you click on a word in my miro mind map you will be taken to a new page to read about the topic you clicked on.  Each page of my website still has this miro mind map at the top so you can navigate to another topic in the map. So here is where I want to go with this.  I want the mind map to stay at the top of the page where the user has zoomed in or moved it etc, and when the user clicked on something in the map instead of being taken to a whole new page I want to capture what the user has clicked on and change the bottom half of my html page where the info is.  Meaning, everytime a user clicks on something in the map the state of the map stays the same because the user is not taken to a new webpage instead it is triguring some ht

2
Simon.Harris
2 years ago
S
saifisBeginner
asked in Developer platform and APIs

Is there a way to set the "z-index" equivalent when creating objects with the api?

I’m making objects and some of them go under some objects that I want to be in the background, is there a way to set the, in CSS terms z-index, putting some objects “backwards?”

1
Max Harper
2 years ago
S
saifisBeginner
asked in Developer platform and APIs

Is there a way to control details on the card object when zooming out

I’ve made a card using the api, and have a card like so, The issue is the bottom part of the text gets cut when zooming out, is there anyway to control what is shown or not when zooming out?  

2
Boris Borodyansky
Mironeer
2 years ago
S
saifisBeginner
asked in Developer platform and APIs

Running callbacks to users not logged in

I have a plugin that generates objects to aid in workshops online and providing visual aids to them on Miro, the object creation itself is done by a logged in user, but I want to do some updates to a card object that are done by users who are joining in that are not logged in.I just want to change the color and rotation of a card, is this possible?I’ved added  async function checkCardMovments( widget_id ){        await miro.board.widgets.update({ id: widget_id,                                           rotation: 0,                                          style: { backgroundColor: '#FCEEF0'} })}  miro.onReady(() => {    miro.addListener('WIDGETS_TRANSFORMATION_UPDATED', (e) => {        if( (e.data.length == 1) && ( e.data[0].type == 'CARD' ) ){            checkCardMovments(e.data[0].id)        }    })  } to the miro.onReady of the js file that is initializing the plugin, it works fine if I am a logged in user but the callback doesn’t seem to run at all if its an anon user

2
S
2 years ago
J
June PrukNew Here
posted in Developer platform and APIs

Problem when embedding the board

Hi !Does anyone expereince an issue on when embedding the board in the Presentation mode?It is now display with “Something went wrong” error, use to work before. Here is the code:<iframe width="640" height="360" src="https://miro.com/app/embed/o9J_ks8pWXc=/?&pres=1" frameborder="0" scrolling="no" allowfullscreen></iframe> Taking the “&pres=1” seem to make the code functioning again.But I really need to use the presentation view. Does anyone know the solution/ workaround? Thanks in advance.

5
D
2 years ago
J
Jim JonesNew Here
posted in Developer platform and APIs

Participatory Narrative Inquiry (PNI) Online - can MIRO help?

Hi I’m a Knowledge Manager at ORIAS in Canada where i specialise in  participatory working with clients using Participatory Narrative Inquiry developed by Cynthia Kurtz and the Future-Backward timeline method developed by Kurtz and Snowden at Cognitive Edge.FB works by creating a story timeline using tesselating hexes place first to describe the present, then working backwards into the past before describing a state of  ‘heaven’ which partciapants then work towards in a step-wise fashion. The process can be sued for both sensemaking and action planning.Normally and ideally this is best done round a table, but in the age of COVID im looking to develop online options. MIRO seems a great platform to do this with. If anyone has any experience of designing templates or knows of something similar which can be adapted it would be great to hear from you.

5
D
2 years ago
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

6
P
2 years ago
J
Jane OrmeNew Here
asked in Developer platform and APIs

Board picture API - no content

I’m trying to get a board picture using the API: https://developers.miro.com/reference#get-picture however when I enter the “boards” value and the correct board ID (checked separately using the get boards url) I get nothing returned. The example says that the following should be returned: { "type": "picture", "imageUrl": "https://r.miro.com/1234567890/0987654321/1234/4/1/size210.jpg", "id": "3074345367401345438" }   so why am I getting a 204 no content response?

1
Boris Borodyansky
Mironeer
2 years ago
K
Kingsley ChanBeginner
asked in Developer platform and APIs

return menu items with promise in getWidgetMenuItems

Hi,   I am trying to make a request to our server before returning the context menu in `getWidgetMenuItems` method. But the context menu not showing correctly when any delay occurs (even if I create a promise with settimeout for 10 ms). The context menu items may not able to display when I click on an item within the board. If I remove the settimeout, the context menu items will show correctly.   Something like this: getWidgetMenuItems: async (widgets, editMode) => {   const promise = new Promise((resolve, reject) => {     setTimeout(() => {       resolve([         {           tooltip: 'Tools',           svgIcon: 'svg-icon',           onClick: async() => {             // on click event           }         }       ]);     }, 10);   });   const result = await promise;   return Promise.resolve(result); }   Regards,  K

1
Ahmed El Gabri
Mironeer
2 years ago
Terms & Conditions