Developer platform and APIs

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

  • 874 Topics
  • 2,751 Replies

874 Topics

Y
YOUNES HAMZABeginner
asked in Developer platform and APIs

Power BI visual into Miro

Hi everyone,I'm trying to embed a Power BI visual into Miro, but I want to resize the visual to fit my needs without embedding the entire report. Is there a way to edit the iFrame embed link to accomplish this?I would be grateful for any advice or guidance on how to customize the iFrame embed links for Power BI visuals in Miro.

4
W
1 month ago
P
paulgNew Here
posted in Developer platform and APIs

Miro SDK - Connector event listeners

Hi,I want to know if event listeners are available on connector events (creation, deletion and modifications. i.e. a user modified a connector connecting elements A and B to connect elements A and C) on a miro board. I am looking at the documetnation and the only relevant thing I can find is this:experimental:items:updateWhich says: Currently, experimental:items:update fires only when items are moved on the board, when an item dimensions are resized, when an item is rotated on the board, and when updating the scale of an item. In the future, the event will also fire when updating other item data.I read this as saying that connectors are not currently supported.Is this correct or am I missing something in the documentation?Thanks in advance

4
William Bishop
Mironeer
2 months ago
E
Eduardo CastellanoBeginner
asked in Developer platform and APIs

How to access the text of the tags inside the stickly notes or app cards?(Using Web SDK v2)

Greetings colleagues,In the past, I developed a small private application with the web sdk v1. It was very basic, I added the application in the context menu and when selecting a series of widgets (sticky notes, app cards, etc..) my application appeared in the context menu and in its inner workings what it did was to go through the selected widgets, search the tags inside them and add those that matched a specific numerical format.I want to migrate it to version 2 of the new sdk and the truth is, it is being quite difficult.I have read the documentation and I think that the closest thing to my needs is to make a CustomAction.I have been able to add my customAction to the context menu and show an information message when I click on it. I need to be able to read somehow the content of the tags, their text, but I can't find any way to do it. Is it possible to do it somehow? I share my code with you: import type { CustomAction, CustomEvent } from "@mirohq/websdk-types";const actionHandler

4
E
1 month ago
T
Tim MoserNew Here
posted in Developer platform and APIs

BUG: Rest API creates board in view only

Below is a bug report for some unexpected behaviour I have found when working with the api as a free plan user. Steps to reproduceCreate a board using an access token of a free account through the REST API, noting the resulting board ID (post v2/boards) Create a frame in the board (post v2/boards/ID/frames)Actual Result403 - User is not authorized to create widgets on this board.Upon further investigation in the miro dashboard, I notice that the board is created in view-only, therefore not allowing me (and my access token) to edit it.Expected ResultSince the created board is the most recent board, it should be editable even for free accounts exceeding 3 boards (by making an older one view-only). This would then allow me to also edit it through the api, without the error.

4
T
5 months ago
M
mHazimBeginner
asked in Developer platform and APIs

Mass Copy Board

Hi,I have been testing the API functionality, specifically mass-copying a board to multiple Miro Teams.  However, I can’t seem to get this working properly. Please note that I am new to json and rest api, so I may be getting the syntax wrong.For example, using the copy_from parameter, the body looks something like this:    { "boards": { "board": [ { "policy": { "sharingPolicy": { "teamAccess": "edit", "inviteToAccountAndBoardLinkAccess": "editor" } }, "teamId": "3458764577105192620", "name": "Test 0" }, { "policy": { "sharingPolicy": { "teamAccess": "edit", "inviteToAccountAndBoardLinkAccess": "editor" } }, "teamId": "3458764577105192620", "name": "Test 1" } ] }}For some reason, running the above creates a copy of a board named “copy of original board name” and places it in DevTeam instead of the

4
M
1 month ago
S
saifisBeginner
asked in Developer platform and APIs

How to get drag and drop event to get coordinates

I’m making an app where dropping a card on top of a shape object needs some functions to be called, so I want to catch when cards are moved, I tried using “WIDGETS_TRANSFORMATION_UPDATED”  but it doesn’t give coordinates, I’ve tried getting the common ‘dragend’ on document and it did no go well either, any suggestions would be greatly appreciated.

3
J
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
2 years ago
S
Sucheta ParchureNew Here
asked in Developer platform and APIs

Miro and WordPress Intergration

How to integrate miro apps with wordpress?

3
V
3 years ago
P
Patrick KeenanNew Here
posted in Developer platform and APIs

Card Icons. Hierarchical Tags, RDF I/O

Hi there, I'd like to do 4 things. I'm wondering if someone has done these, or if there's a simple way to "hack" the functionality. Thanks! 1. Cards with icons. I'd like to be able to add an icon to a card. 2. Hierarchical tags. I'd like to have nesting in tags to import an existing hierarchy. 3. Import RDF. I'd like to create an importer of RDF files, so it would map them to a visual. 4. Export RDF. I'd like to take my mappings and export them to RDF.

3
Max Harper
3 years ago
E
esenNew Here
asked in Developer platform and APIs

LTI integration with a LMS

Hello, has anyone integrated MIRO with a learning management system so MIRO whiteboards can be used within a learning management system? Thanks!  

3
P
2 years ago
M
mxvrhubNew Here
posted in Developer platform and APIs

SOS! I lost access to the board I was developing. Free trial.

I would like to report a problem with access to the board I was using/developing.Somehow, the owner of the board is someone I don’t know. I don’t know that person and I don’t understand how it’s possible, that my content is not under my name. It’s a mess.Probably, this person had an empty board and I started creating my mind map there… I did not realize that was not the way to do it. I still don’t understand what just happened. I NEVER chose or agreed to follow the other boards either. I have no idea how and why they appeared on my list/dashboard. I have been trying to leave them, but there’s no such option. I want to leave all the boards except for one — that I have been working on for months. I currently technically cannot execute an upgrade for my account and I depend on the information that I have on my board. PLEASE, HELP! ASAP  Thank you!

3
mlanders
3 years 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
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
mlanders
mlandersExperienced Community Member
asked in Developer platform and APIs

Error in sticky notes

I have noticed something strange: I created a Sticky Note and wanted to wrap the words into two lines. As I clicked enter it shows me this: I have seen this only one time before but I cannot remember how I could reproduce it. Any solution? Michael

3
mlanders
4 years ago
Kirill Hazukov
Kirill HazukovNew Here
asked in Developer platform and APIs

Add icon to widgetContextMenu

Hi everyone! How i can add an application icon to the widgetContextMenu? By looking at the documentation, i tried the following code: miro.onReady(() => {  miro.initialize({    extensionPoints: {      widgetContextMenu: {        title: 'Hi',        svgIcon: "<circle cx=\"12\" cy=\"12\" r=\"9\"></circle>",      }    }  })}) but in console i get the following error However, I can do it in bottomBar if I replace “widgetContextMenu” with “BottomBar”.

3
Kirill Hazukov
4 years ago
ronny
ronnyContributor
posted in Developer platform and APIs

OpenAPI/swagger file to auto generate SDK

  Do you have a OpenAPI/swagger file for the Miro REST API? We want to auto generate a SDK for TypeScript/NodeJS SDK. In case you don’t have this, we saw this Typescript definition file on your Github: https://github.com/miroapp/app-examples/blob/master/miro.d.ts - Is the idea that we copy this for our usage (better: can we link it somehow, so we get updates when you adjust it)? Many thanks!

3
Thomas Vanier
1 year ago
A
alloplasticBeginner
asked in Developer platform and APIs

Can a custom web plugin be installed for individual users and boards?

Hi. I have created s simple “Web-plugin,” which I have successfully installed for the Dev Team.  Every developer can see the new plugin button in the toolbar when they go to a Dev Team board. What I would like to do is let individual users in my company (or individual boards) use the plugin.  However, since we have about 1,000 employees around the world, I don’t want to install the plugin for all of them. Is there a way to accomplish this?  On a single Miro board, there appears to be a way to add a plugin just to that board, but the UI only shows plugins in the Marketplace, not our custom plugin.  When I use the “Install App and get OAuth token” button on the developer screen, I get a choice of teams, but I only see our top-level company team, not the individual project teams within the company. Am I overlooking a way to share the plugin at a more individual level? Thanks. Sheldon  

3
F
3 years ago
S
Simon JonesBeginner
posted in Developer platform and APIs

Missing endpoints for API

Some important API endpoints seem to be missing from the Miro API, especially related to the Teams object. I would like to see the ability to list all Teams for a company or create a new Team through an API call. Also there appears to be no endpoints for Projects, which is disappointing. Ideally I’d like the ability to list all teams for a Project and add/delete users from a Project. Are either of these on the roadmap for Miro? 

3
J
3 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
3 years ago
S
saifisBeginner
asked in Developer platform and APIs

How to attach meta data via Webplugins

I know you can add metadata through the API, but I cannot find documentation on how to add meta data via web plugins, I’d like to add a “session_id” to the group of objects I create via a single button and I need a way to group them up for future use.

3
S
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
R
RamkumarBeginner
posted in Developer platform and APIs

Bug Report: Line widget style update impacts bounds/endPosition properties

Hi, When we update Line widgets style through web plugin API, it impacts the read-only bounds/endPosition properties. This cause line widget to switch to undesired position when connecting between 2 widgets. Video for this behaviorhttps://www.loom.com/share/dbadddf3261a49388a28803725f81fa5Notice that the line changes position after color change Before and after comparison of widget properties 

3
Esteban Beltran
Mironeer
3 years ago
C
Craig HardcastleBeginner
asked in Developer platform and APIs

Widget Dimensions

When retrieving all the widgets for a board, you appear to get the x and y but the width and height is not set or is missing. For assets like the AWS icons there isn’t even a reference to the icon being used for the widget that I can see? I am trying to create a tool that will update the board by placing tickets around a given widget on the board. I have done this fine with Draw.io because the position and dimensions of each object is available, but with the miro api those values appear to be missing? Hopefully this is just user error and any guidance would be appreciated 

3
C
3 years ago
F
Ferris440New Here
asked in Developer platform and APIs

Manipulation only - no new board elements?

Hi community, I’m keen to experiment with extending the Miro board with other apps that can be dropped onto the board and used by the team. E.g. and embedded version of Figma, a file store or a coding environment. I can’t use the iFrame widget for this as it defaults to just showing a preview - I want it to show the actual content of the remote session (likely with some kind of user locking mechanism). Am I correct in my understanding however that the widgets/API can only be used to create apps that manipulate existing board items (e.g. place post its) vs create new board entities (e.g. premium post it). Thanks for your help! Luke

3
T
3 years ago
M
Manjula ManoharanBeginner
asked in Developer platform and APIs

Issue while embedding link

I am using Angular 6 , and when I tried to embed the below link <iframe [src]='https://miro.com/app/board/o9J_ldxFWKw=/'></iframe> I am getting the below error in console.Refused to display 'https://miro.com/app/board/o9J_ldxFWKw=/' in a frame because it set 'X-Frame-Options' to 'sameorigin'. any help would be highly appreciated.

3
L
2 years ago
Terms & Conditions