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,747 Replies

867 Topics

B
benman1Beginner
posted in Developer platform and APIs

create Miro app with create-react-app?

Hi there! Is it possible to use my own app starter and use it as a Miro app, ideally create-react-app? My problem with the create-miro-app is that it’s using vite, which causes some (apparently) hard to fix issues when trying to use it in combination with Netlify and Netlify functions… If possible with create-react-app, are there any extra settings/ packages to load in order to make it work as a Miro app? 

4
B
1 year ago
Markus Smet
Markus SmetMiro Hero
posted in Developer platform and APIs

Plugin for sync'ing widget duplicates just launched - CarbonCopy v2

Have you ever wanted to syncronise your Miro widgets so the text, colour or tags remain in sync across your Miro board? Yes? Great, then you take a look at CarbonCopy on the miro marketplace.This version builds on the learnings from the previous version of CarbonCopy.I have isolated the functionality of CarbonCopy from miro’s features. It means a small lag using miro features is removed. CarbonCopy is more closely aligned to miro’s guidelines on apps. Less cost of change for me when miro changes their api in the future. Feedback is integrated inside the app. You can send a message from inside the plugin with your ideas for improvements or bugs you are experiencing.Fancy new feature:It’s now possible to isolate sync’ing at a widget property level. That means you can sync everything on a widget (such as colour and tags) whilst excluding the text which can be unique on each widget. This video gives you a demo on the basics of this feature on a Note widget. Another video explains nice stuf

10
cdp-aw
1 year ago
C
Craig HardcastleBeginner
posted in Developer platform and APIs

Plugin widget.create() promise never complete

Hi, I seem to be having an issue in getting the miro.board.widgets.create() promise to complete. The widgets are created but the returned promise never changes from “pending”. I have tried creating widgets one at a time and in batches but with no luck. As I say the widgets do create but without the promise completing or even erroring there is no way for my code to complete… it just hangs forever :( Anyone else has this issue? My code block is wrapped in the miro.onReady() callback so I don’t think i need to do anything else? Thanks.

6
Daniela Gavidia
Mironeer
3 years ago
N
nick bogaertNew Here
asked in Developer platform and APIs

Company Templates feature on consulting plan

We are on a consulting plan and create a team for every client we work with. We recently put a lot of effort into creating miro templates for all our tools to realize that we have to add these to every team separately. This is not only a lot of unnecessary work every team we add a new client, it also means that we can’t change our templates centrally. The current workaround - copy pasting templates from our company team into boards for client teams -is time consuming and creates a lot of clutter in the form on unused boards on our company team. The feature to make this accessible across team accounts already exist on the enterprise plan. Given the nature of most organizations that are on the consulting plan it would make a lot of sense to add it to the consulting plan as well!

2
Dominique Rolink
Mironeer
2 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
3 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
3 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
MarkNew Here
asked in Developer platform and APIs

Simple plugin no longer working. XML Parsing Error: prefix not bound to a namespace?

Hi, I had a simple plugin up and running that executed a function when I clicked a new icon in the bottomBar. I used some of the example code to get up it set up and everything worked ok. Now the icon no longer appears in the bar. The browser tools show that there is an error message (before the plugin is loaded though) that says: XML Parsing Error: prefix not bound to a namespace. I am not sure if this error message is new or not. Has something changed that means the the button-display code needs to change? The relevant plugin code is: miro.onReady(() => { miro.initialize({ extensionPoints: { bottomBar: { title: 'Post-it Counter', svgIcon: '<circle cx="12" cy="12" r="9" fill="none" fill-rule="evenodd" stroke="currentColor" stroke-width="2"/>', onClick: async () => {...} updateCount(); } } })})

2
M
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
3 years ago
Robin Vessey
Robin Vessey
posted in Developer platform and APIs

Rest API Creating projects

Hi,In the miro dashboard you can group boards into projects.How do I add a project and then add the board to a project? 

7
C
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?

5
A
5 months ago
S
SathiaBeginner
asked in Developer platform and APIs

Export to Image - API

Is any other option available for export the board in format of image using miro API?

1
Daniela Gavidia
Mironeer
3 years ago
M
Markus EdenhauserBeginner
asked in Developer platform and APIs

SDK: get current zoom and position

Hello, I would like to place a shape on the center of the current screen. So I slide a bit to the right click on my plugin and it creates it in the center of the scroll position. With miro.board.viewport.get() I seem to get the whole viewport with all screens, etc and it would position it wrong, even if I try to calculate it like that:  const viewport = await miro.board.viewport.get(); const zoom = await miro.board.viewport.getScale(); const vw = Math.max(document.documentElement.clientWidth || 0, window.innerWidth || 0) const vh = Math.max(document.documentElement.clientHeight || 0, window.innerHeight || 0) calculated.centeredX = (vw * zoom) / 2 + viewport.x; calculated.centeredY = (vh * zoom) / 2 + viewport.y; console.log(calculated, viewport)My assumption is that viewport.x is the left position and viewport.y the top positon to of my current visible browser window. Then I read my browsers window height and width, half it to get the center and multiply it with th

3
Marijn Huizendveld
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
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
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
ronny
ronnyContributor
posted in Developer platform and APIs

IDEA: Add hidden markers to widget

We create widgets via the Miro API and query them afterwards back. We need to know which widgets are what (e.g. to find stickers placed within a specific widget). So far, we rely on the text to match the enclosing widget. Yet, this leads to issues if users change the text in the Miro UI and it’s cumbersome if boards are localized (i.e. lots of text variants to match). (Aa an alternative, we considered storing the Miro widget ID but that’s tricky as it requires us to hold this state.) We would like to send a hidden marker to the API during widget creation, which is then returned when querying for widgets. As a parallel, consider the ID field in HTML elements: The developer sets it, website users don’t see it and can’t change it, yet developers can query the elements afterwards with this ID via `getElementById`.

4
Anthony Roux
Mironeer
1 year ago
C
Craig HardcastleBeginner
asked in Developer platform and APIs

Plugin widgets.get() by id doesn't seem to work

Hi, I am trying to get widgets by id using the await miro.board.widgets.get({ id }) but it doesn’t appear to work? I have tried single ids, array of ids, both with strings and integers and nothing comes back? Is that expected behaviour? This is within the onReady callback; Thanks, Craig

3
C
3 years ago
M
Maximilian HallettNew Here
asked in Developer platform and APIs

Connection Lines Size

A small question that probably doesn't have a solution yet. Is there way to get around the scaling parameters for the connection lines feature? I want to make my lines thicker in appearance because of the scales that I am working within my Miro Board. Subsequently my connection lines are thin in appearance even when set to the maximum thickness.

3
K
1 year ago
Fredrik Wendt
Fredrik WendtContributor
posted in Developer platform and APIs

Lock & Hide Frames via REST API

We run workshops and trainings, usually with about 100 frames/exercises. For every class/workshop, these are copied from a template and there’s usually some manual tweaking to be done by the trainer. I set out to write a simple tool that would unlock & unhide all frames, let the trainer make some tweaks, and then run the tool again to lock (in place) and hide (to prevent peaking ahead) all frames.I was surprised that frames are readonly. Is there any workaround to this issue of having to click at least 200 times (lock, hide) to get ready to run a workshop?

5
A
Mironeer
7 months ago
Bentley Davis
Bentley DavisBeginner
posted in Developer platform and APIs

Error when using Airtable (and other npm packages) with create-miro-app React Typescript

Has anyone else tried using libraries with the create-miro-app React TypreScript option? I followed the Hello World Miro example and it works fine but when I add Airtable and even though none of the Airtable code runs I receive the error:Uncaught Error: Module "stream" has been externalized for browser compatibility and cannot be accessed in client code. at Object.get (browser-external:stream:3) at node_modules/node-fetch/lib/index.mjs (index.mjs:10) at __init (chunk-EB7XYW2R.js?v=d66c9224:9) at node_modules/airtable/lib/fetch.js (fetch.ts:2) at __require2 (chunk-EB7XYW2R.js?v=d66c9224:12) at node_modules/airtable/lib/base.js (base.ts:4) at __require2 (chunk-EB7XYW2R.js?v=d66c9224:12) at node_modules/airtable/lib/airtable.js (airtable.ts:1) at __require2 (chunk-EB7XYW2R.js?v=d66c9224:12) at dep:airtable:1I have spent several hours looking it up and trying different options but even though the error changes I have not been able to make it work. Here is a sa

4
A
3 months ago
F
ftassiNew Here
posted in Developer platform and APIs

WebPlugin error. Uncaught Error: processCommandFromIFrame:: iframe channel not found

Hi, I’ve created a simple test plugin using one of the examples app as a scaffolding. The web plugin allows the user to roll a number of random dice. This is the installation link for the  app (still in development of course) https://miro.com/oauth/authorize/?response_type=token&client_id=3074457350145576827&redirect_uri=https://miro-rory-story-cubes-prod.herokuapp.com/auth-success.htmlThe app seems to work fine most of the time but for some users and on some teams, it works just once. After first usage we get this error:Uncaught Error: processCommandFromIFrame:: iframe channel not found, plugin = 3074457350145576827, cmd = .board.viewport.getViewportIf we reload the board and use it, it works the first time and triggers the error from then on.The issue seems to be consistent for certain combination of user/team/browser. EgI can use it on Team A, always I can use it on Team B, always, using firefox I can use it on Team B, only once, using chrome A teamamate can use it on Team B

3
G
2 years ago
ronny
ronnyContributor
posted in Developer platform and APIs

IDEA: Provide flexible colors for widgets

We would like to brand the look & feel of the canvas by using our own color schema (e.g. for background, stickies, shapes). Unfortunately, today, the API rejects any other color than the 12 predefined ones. PS: The example in the API Explorer doesn’t work because it uses invalid color #ff00ff (https://developers.miro.com/reference#create-board-widgets).

1
farbodsaraf
Mironeer
3 years ago
J
Jeff CarnahanBeginner
asked in Developer platform and APIs

Guest T&C Acceptance

Is there a way to have a T&C pop up for guests to accept before they can view/interact with a board?

4
Daniela Gavidia
Mironeer
3 years 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
3 years ago
Terms & Conditions