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>

  • 941 Topics
  • 3,004 Replies
941 Topics
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
4 years 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
4 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
4 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
4 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
4 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:&lt;iframe width="640" height="360" src="https://miro.com/app/embed/o9J_ks8pWXc=/?&amp;pres=1" frameborder="0" scrolling="no" allowfullscreen&gt;&lt;/iframe&gt; Taking the “&amp;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
4 years 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
4 years 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
4 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
4 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
4 years ago
Steve Appling
Steve ApplingBeginner
asked in Developer platform and APIs
Positioning content in parent frame

I’m using the REST API to try to add stickies to a frame, similar to the GitHub Issue Importer example.  I find that if I specify a parentFrameId, that the x and y position is ignored and the sticky is added to the center of the frame.  If I don’t specify a parentFrameId and give an x and y, then I can position them, but they aren’t considered children of the frame unless I go into the board manually and wiggle the stickies.   How can I put content into a frame and not have it all stacked on top of each other?  Also, I couldn’t find documentation for the parentFrameId in your API documentation.  It is only mentioned in the example.

1
farbodsaraf
Mironeer
4 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(() =&gt; {    miro.addListener('WIDGETS_TRANSFORMATION_UPDATED', (e) =&gt; {        if( (e.data.length == 1) &amp;&amp; ( 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
4 years 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
4 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) =&gt; {   const promise = new Promise((resolve, reject) =&gt; {     setTimeout(() =&gt; {       resolve([         {           tooltip: 'Tools',           svgIcon: 'svg-icon',           onClick: async() =&gt; {             // on click event           }         }       ]);     }, 10);   });   const result = await promise;   return Promise.resolve(result); }   Regards,  K

1
Ahmed El Gabri
Mironeer
4 years ago
Steve Appling
Steve ApplingBeginner
asked in Developer platform and APIs
Trouble using app outside of developer team

I’ve created an app and tested it in my dev team.  Now I want to use it on my real team with other users.  From step one here, it looks like I should be able to use the “Install app and get OAuth Token” button to get an accessToken.  While I was able to get one that works on the board in my dev team, it doesn’t seem to work for boards in my real team.  If I go to the “API, SDK &amp; Embed” tab of my profile, I see my test app listed associated with a team of “Dev team”.   I can’t seem to edit this to associate it with another team.  If I try to create a new app, it only lets me pick the Dev team. How can I use this app I created with a real team?  It’s a command line tool, so I don’t think I can participate in an OAuth flow.  It’s not running from a web site.

1
Boris Borodyansky
Mironeer
4 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
4 years ago
S
Steve StringerNew Here
asked in Developer platform and APIs
Is there an easy way to calculate dates automatically for a calendar?

I’m building a class calendar using the Monthly Planner template.  I’m wondering if there’s a way using JavaScript, Python, or simply a unknown-to-me feature that lets me easily start a calendar on a date and have it fill in the rest of the date labels on the calendar.  Seems like this should be a built-in, commonly used feature, but apparently not. Or, alternatively, is there a better calendar template?  I do semester-long calendars that map out an entire course with milestones, holidays, lectures and assignments.  There seems to be two versions of the Monthly Planner template.  When you create it in the browser app, it’s a weekly planner with generic labels.  If you create one using the desktop app, it’s more like a familiar calendar grid, but without dates.

2
A
4 years ago
J
Jason BougasBeginner
asked in Developer platform and APIs
Is it possible to use an OData connector to extract data from the Miro API?

I am trying to connect to the API using OData and am unsure if this is available in Miro or whether only REST API is available.  Anyone done this?  I’d like to get the data for a board into Power BI.

2
farbodsaraf
Mironeer
4 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
4 years ago
K
Kingsley ChanBeginner
asked in Developer platform and APIs
Frame widget's metadata doesn't presist

I have programetically created a Frame widget with metadata ``` [appId]: {   type: ‘type’,   id: ‘AAAA’,   latestVersion,   majorVersion,   minorVersion,   statusVersion, }, ``` The metadata exists when the frame is created, but after I back to the board listing page and go back to the board, all the metadata in the frame are gone. The metadata are presist in Text widgets and Image widgets, but Frame widgets has this weird behaviour.   Regards,  K

4
C
4 years ago
T
tahsin can sarlakNew Here
asked in Developer platform and APIs
Creating a board using p5.js / javascript

Hello,   I would like to create a board using a p5.js program I am developing. It takes JavaScript. However, when I copy paste the code Miro generates, it returns null, where as it should have returned me an object. I tried the other languages and they work fine. Although, I need the JavaScript working.   Could someone please help me?   PS. I tried both fetch and xhr

1
Viktor Dolhishev
Mironeer
4 years ago
L
Lincoln MitchellNew Here
asked in Developer platform and APIs
How best to get website user flows in Miro?

I have a prototype in FramerX and can only see all the user flows when playing the prototype in Framer X or via a URL in the browser. To get these user flows in Miro, I’m taking screen grabs, pasting the screens and adding arrows. But would love to be able to have this automatically generated.  Ideally, integration between Miro and Framer X would be brilliant, but for now, just being able to point to a URL and have Miro do the rest would be great. Is this possible?

1
Viktor Dolhishev
Mironeer
4 years ago
R
Rajat JainNew Here
asked in Developer platform and APIs
APIs to get all users and licenses in a company not just in a team ?

How I can create an integration such that I can pull all users and licenses for all the team. Or How to pull all the team ids first such that I can pull all users for each team id ?

1
S
Mironeer
4 years ago
E
EgorNew Here
asked in Developer platform and APIs
Undo working result of the plugin

Hello! I am plugin developer and i want to do feature which allows user undo working result of my plugin, i can do this in entries of my plugin but will be cool if i integrate this into miro undo\redo functionality, so can i achieve this or this is impossible?  

1
S
Mironeer
4 years ago
A
Ashley RawboneNew Here
asked in Developer platform and APIs
Adding a "sticker" to a Frame or Grid using the Miro REST API

Is it possible to add a “sticker” to either the Grid or Frame widgets using the Miro REST API? I’m successfully adding “stickers” to boards at specified x and y co-ordinates, but I can’t seem to find a way of setting the “stickers” parent.

2
Steve Appling
4 years ago
Terms & Conditions