Developer platform and APIs

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

  • 703 Topics
  • 2,325 Replies

703 Topics

M
Maximilian PopraweBeginner
asked in Developer platform and APIs

Settings for a web-plugin

Hi all!How do I set up my plugin to have settings on the Apps&Integrations page? I would like to give the user some configuration options.Alternatively, I guess this can be done with a modal view (to configure) and a hidden widget (to store). Is that a good approach? Are there better ways to let the user configure a plugin?Thanks for your help :)   

2
M
2 years ago
Sami Ljimari
Sami LjimariActive Contributor
asked in Developer platform and APIs

How to correctly use bringForward() and sendBackward() Miro board functions

Hi, I’m trying to use bringForward() and sendBackward() Miro board functions which I found here: https://github.com/miroapp/app-examples/blob/master/miro.d.ts (line 351 - 357) I assumed this only needs the widget id’s in an array but when I tried with some test data it doesn’t actually change the widget “priority” AKA doesn’t send them forward or backwards. Tried something like this: `sendbackward(arrayOfWidgets)` where arrayOFWidgets were a few selected widgets from current boardIs there a specific use case that has to be done like with miro.board.commands , where they have to be in a miro on ready block? Or am I missing something else?  Thanks for any suggestions

2
Sami Ljimari
2 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
2 years ago
M
Morgan WallNew Here
posted in Developer platform and APIs

Card Due Dates pulling wrong

Has anyone else experienced an issue where the due date on your card does not match the “date” field when pulled from Miro?  This is happening in about 50% of the cards I am pulling and for all of them the incorrect date is one day ahead of the correct assigned date.  eg. if the due date is “Nov. 12” the output json from a Python Requests API pull will say “Nov. 13”.   I have not noticed any correlation with when the cards were created or modified.  

1
Daniela Gavidia
Mironeer
2 years ago
R
Richard121212Beginner
posted in Developer platform and APIs

How to get/upload image-data for a widget through the REST-API (url is null)

Hi,We have created a nice integration through your nice api. Widget stickers, frames etc do work fine. But accessing the data of Widgettype “Image” does not provide sufficient information.your documentation says this type would be readonly. But in the API result there is no specific data to get the image: "id" : "xxxx",    "title" : "",    "url" : null,    "x" : 9085.834285822924,    "y" : -4194.224152236103,    "width" : null,    "scale" : 1.6019392388194886,    "rotation" : 0.0,    "type" : "image",    "createdAt" : "2020-11-12T15:25:13Z",    "modifiedAt" : "2020-11-12T16:14:18Z",    "modifiedBy" : { The GetPicture API (https://developers.miro.com/reference#get-picture) seems only applicable for main boardpictures and not images an a frame (as far I can see)So how can we retreive the images on a board? (and we would also upload new ones...)Thnx

16
Joanna Smith
Mironeer
1 year ago
K
Kenya SuzukiNew Here
asked in Developer platform and APIs

How to set getToken response

Hi there, I want to use Embed miro board.So, I implements frontend plugin referring below.https://developers.miro.com/docs/editable-boards-for-anonymous-users Then, I have a question.When we use miroBoardsPicker.open, what kind of values should be passed to getToken property?In the document, they say only we should generate jwt in server side.I want to knouw actual type of the property. Regards,

2
K
2 years ago
D
Danny HolyoakeNew Here
asked in Developer platform and APIs

Using REST API to change User's Role causes System Error

Heya,I am trying to use the REST API to automatically deprovision our users when a member leaves the team.I am using the Update Team User Connection endpoint to change a member’s role from ‘member’ to ‘non_team’. I’m doing this because it’s the best way to ensure a member’s boards aren’t deleted when their account is removed.When I try this with an account, I get a 500 error, both via Postman and the API reference page, with the message InternalError.After this happens, the user can no longer access the Team Boards at all. The web interface’s Users list still lists them as a Full member, and presumably they are still licensed as such.When using the API, the user is no longer listed under List All Team Members, and the Team User Connection ID will 404.Is this a bug that I'm running into, or am I doing something wrong here? Is there a better practice to deprovision users?Thanks for any help you can provide!

1
Daniela Gavidia
Mironeer
2 years ago
T
Todd AndersonNew Here
asked in Developer platform and APIs

Custom widgets

Hello,  Is it possible to create custom widgets?  I’d like to create a sticker widget that has an autocomplete select-box of previously entered values in my app database.  Something like https://jqueryui.com/autocomplete/It doesn’t seem like I can add components or additional JS to widgets to make them more useful.  Is this something that’s possible, or will be in the future?  I think if the functionality was opened up a bit then there is a lot of potential for creating really cool apps.

5
Ben Nowak
7 months ago
Sami Ljimari
Sami LjimariActive Contributor
asked in Developer platform and APIs

Get user id

Hi,I have tried a few ways to get the current user id, but I always encounter a error in one way or another. What is the most basic way to get a user id? So far I have mainly tried this: async function getUser() {        const proxyurl = "https://cors-anywhere.herokuapp.com/" // getting cors error without this        const url = "https://api.miro.com/v1/users/me"         const options = {            "method": "GET",            "headers": {                “Authorization”: `Bearer ${token}`,                "Content-Type": "application/json"            }        }         fetch(proxyurl + url, options)        .then(response => {        console.log(response)        })        .catch(err => {        console.error(err)        })    }I’m currently getting error 401 “Not Authorized”I’ve seen a few discussions in here about a direct miro dot command that can get the user id but can’t find it anywhere in the documentation. Will be thankful for any suggestions as I ran out of ideas of what to

2
Sami Ljimari
2 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
2 years ago
C
CSABeginner
asked in Developer platform and APIs

Edit web-plugin after install

I’m new to creating plugin for Miro. I have created a test plugin by follwing https://developers.miro.com/docs/how-to-start this & successfully added to my board. But how to modify/change my plugin after installation. When I change the code in index.js file of my web page which is hosted in the web plugin url, the plugin does not affect. It keeps un changed. How to update my plugin to affect changes.Thank you

6
Robert Johnson
2 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
A
Andrei JNew Here
posted in Developer platform and APIs

Detect changes using the sdk

I am writing a plugin that detects changes in a board (widget created, deleted, etc), and I want to take a screenshot of the change.The plugin can detect those changes, but I am stuck at the screenshot part. I have tried to integrate an iframe in the plugin but with no success. I want to ask you what ideas would you suggest?

2
Max Harper
2 years ago
M
MohsenBeginner
asked in Developer platform and APIs

The METADATA_CHANGED event does not call back.

The METADATA_CHANGED event is still experimental, and it does not call the call back in my browser. How can I subscribe to it? having it is really useful.

2
M
2 years ago
Sami Ljimari
Sami LjimariActive Contributor
asked in Developer platform and APIs

Is it possible to use window.location.pathname to get Miro board path while using REST API?

Hi,I’m using Miro REST API in the form of a sidebar, I’m trying to export data to a external database and would like to mark each dataset with its corresponding miro board ID from the board url like this one for example: https://miro. com/app/board/hereistheboardid/I’m trying to do this by calling window.location.pathname.split('/') from which I then obtain an array of paths in the link. Unfortunately the paths that I get returned back are ones from my server where I keep the code to my miro REST API  Outlined in blue is my sidebar, from which the url path gets returned, but in the red there is underlined the actual window url / location which I believe it should return. Any ideas how to get the miro board URL via my REST API / webplugin?

1
Daniela Gavidia
Mironeer
2 years ago
B
Bob S
asked in Developer platform and APIs

How to start building

Hi guys,I want to code a simple calculator to use inside the Miro environment.Since I am completely new to doing this in Miro: Do I need to build this functionality within my own HTML environment and embed this piece of code within Miro using something like an iframe? I can’t figure out if it’s always a ‘web plugin’ you’ll have to load from your own website/environment.If someone can explain me where to start, thanks a lot!All the best,Bob 

2
B
2 years ago
JeremyJ
JeremyJBeginner
posted in Developer platform and APIs

Bug with embed iframe

Hi, I have trouble with embed from miro. I used this code in my website <iframe width="100%" height="400"src="https://miro.com/app/embed/o9J_kkXmwko=/?autoplay=yep" frameborder="0" scrolling="no" allowfullscreen=""></iframe> but I have an iframe like that : miro.com And i have a error on the the console :Uncaught ReferenceError: rtb is not defined    at Object.p (embedEntry.23055cf40587a7dd6af2.js:2)    at Object.O [as storeUserIds] (embedEntry.23055cf40587a7dd6af2.js:2)    at t.apiHost (embedEntry.23055cf40587a7dd6af2.js:2)    at G.apiHost (embedEntry.23055cf40587a7dd6af2.js:2)    at Object.<anonymous> (embedEntry.23055cf40587a7dd6af2.js:2)    at p (runtime~embedEntry.09c728ffbf645e3ac835.js:1)    at Object.<anonymous> (embedEntry.23055cf40587a7dd6af2.js:2)    at p (runtime~embedEntry.09c728ffbf645e3ac835.js:1)    at Object.<anonymous> (embedEntry.23055cf40587a7dd6af2.js:2)    at Object.<anonymous> (embedEntry.23055cf40587a7dd6af2.js:2) Thank for yo

2
JeremyJ
2 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
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
2 years 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
2 years ago
Sami Ljimari
Sami LjimariActive Contributor
posted in Developer platform and APIs

Get miro board object

Hi, I would like to get a Object of the whole, complete miro board. Found this article in documentation: https://developers.miro.com/reference#get-board  But it doesn’t include any miro board command that can be used like with board widgets for instance which have something like this: miro.board.widgets.get()tried miro.board.get() but the feedback I get from console is that it is not a supported function, so the question would be if there is any integrated way of getting the whole board as an JSON object for the sake of “replicating” / “duplicating” the board contents on a new board for instance. Also, how should I go on about getting custom board objects like images to get them on a new board since I would like to get the exact copy of a already existing board which may include .jpg (or similar) files on it. Alternatively is there a different / better way to do a task like this? Thanks for any suggestions

2
Sami Ljimari
2 years ago
R
Ryan Wagner
posted in Developer platform and APIs

Counting the different colors used on a board

I would love an API (if I’m using that term in the right way) for counting individual colors used on a board. Does anyone have the ability/desire to create that?

20
S
11 months ago
Sami Ljimari
Sami LjimariActive Contributor
asked in Developer platform and APIs

How to implement miro.board.widgets.get() or .create()?

Hi,Sorry if this is a trivial question or is at some point answered in the documentation. But I have been trying multiple ways of implementing these 2 methods and none seem to work right now. I’m trying to use this functionality in a miro board extension, the biggest problem is that my implementation worked on last friday, but when I tried to follow up on monday, I have this error every time: Uncaught TypeError: Cannot read property 'widgets' of undefinedMy attempts to use these methods:1)let allWidgets = miro.board.widgets.get()2)let AllWidgetsOnBoard = Promise.resolve(miro.board.widgets.get({        "type" : "SHAPE"    })) //returns all widgets on board with shape type    AllWidgetsOnBoard.then(function(v) {        console.log("AllWidgetsOnBoard: ", AllWidgetsOnBoard)    })3)let allWidgets =  miro.board.widgets.get().then(function() {        console.log("widgets on board: ", allWidgets)    })    console.log("widgets on board: ", allWidgets)4) return miro.board.widgets.create({       

2
Sami Ljimari
2 years ago
Sami Ljimari
Sami LjimariActive Contributor
asked in Developer platform and APIs

Is there a miro board command to gather all widgets?

What is the best way to get a list of all widgets on miro whiteboard. I would want something like “miro.board.widgets.get.all”. Used this for reference https://developers.miro.com/reference#get-board-widgets-1 Edit: deleted the original question, this ^ was pretty much it 

5
V
Mironeer
2 years ago
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
Terms & Conditions