Skip to main content

Developer platform and APIs

Discuss everything related to Miro API, SDK, embedding and Miro Platform apps development.

  • 1,112 Topics
  • 3,416 Replies
1107 Topics
G
Geir ØlnesBeginner
posted in Developer platform and APIs
event for items:delete not fired for Connectors

I have one callback function that is set up with “on(event: 'items:delete' …..” and one callback function set up with the “on(event: 'items:create' …..”The create callback is called for all item types I have tested. The delete callback It is called for all item types I have tested except for type==ConnectorIs this intended fuctionality, or is it a bug?

140
G
C
Carlos LópezBeginner
posted in Developer platform and APIs
Did Miro update the way permissions work? Getting a Insufficient permissions error with out code change

Had configured our app to create boards from other boards (by copying them), and suddenly it stop workingThis is our flow, we call : "https://api.miro.com/v1/oauth/token?grant_type=authorization_code"Then we call:url = URI("https://api.miro.com/v2/boards?copy_from=#{template_id}")And we are getting this error"Full body {\"type\"=>\"error\", \"code\"=>\"4.0602\", \"context\"=>{\"boardId\"=>\"xxxxx=\"}, \"message\"=>\"Insufficient permissions to perform operation. Please check the permissions or contact support\", \"status\"=>403}"Permissions have not been changed in monthsApp has permissions to read / write and original board has view permissions for every one, this error started appearing jus a few weeks ago.

4945
M
A
Andre BennettNew Here
posted in Developer platform and APIs
API to cancel Invitations

I was looking through the APIs but I might have missed it. Is there an API/endpoint that would allow to check and cancel/delete invitations of users.Currently, when trying to create an account, it would fail if the account has pending invitations and login is set to SSO.

262
A
Mira Balani
Mironeer
Mira BalaniMironeer
posted in Developer platform and APIs
Miro Web SDK 2.0 announces the experimental release of the `getVotingResults` method for paid plans that have access to the voting feature

Hey, Miro Developers! We’re excited to announce experimental release of the getVotingResults method for paid plans that have access to the voting feature. The getVotingResults method fetches the results of voting sessions belonging to a board. This method is available only on paid plans that have access to the voting feature.  It’s really important to us that we can create the best possible developer experience when it comes to this new capability, so please share any and all of your feedback with us here, or in our #experimental channel on Discord:https://discord.gg/G8KFgnkCc5 Important: Please keep in mind that this is an experimental feature, so you should not implement or rely on this capability in any kind of production environment, as there may be changes, bugs, etc. We’ll be sharing all feedback directly with our Product and Engineering teams to ensure we’re creating the best version of this capability possible! Ready to get started? Visit our Documentation to start working with

620
Mira Balani
Mironeer
Mira Balani
Mironeer
Mira BalaniMironeer
posted in Developer platform and APIs
Miro REST API introduces create items in bulk

Hey, Miro Developers! We’re excited to announce the experimental support for creating items in bulk with our REST API. This initial release supports the creation of multiple, different types of items to a board, in a single call. You can add up to 20 items of the same or different type per create call. For example, you can create 3 shape items, 4 card items, and 5 sticky notes in one create call.  It’s really important to us that we can create the best possible developer experience when it comes to this new capability, so please share any and all of your feedback with us here, or in our #experimental channel on Discord:https://discord.gg/G8KFgnkCc5Important: Please keep in mind that this is an experimental feature, so you should not implement or rely on this capability in any kind of production environment, as there may be changes, bugs, etc. We’ll be sharing all feedback directly with our Product and Engineering teams to ensure we’re creating the best version of this capability possib

1741
aman
M
Monica PaskvanNew Here
posted in Developer platform and APIs
Duplicates with Jira Integration

How does Miro avoid creation of duplicates with the 2 way push between Miro-Jira (i.e., duplicate objects from Miro to Jira and also Jira to Miro)? Perhaps @Shubangi Sunder has some more info or a video explaining how creating duplicates are avoided in either app (JIRA or Miro)?Thanks.

420
M
William Bishop
Mironeer
William BishopMironeer
posted in Developer platform and APIs
Help us improve Miro for developers: developer survey

Hey, developers! We’re working hard to improve the developer experience of building and publishing apps and your feedback is vital to our work.If you’re a new or experienced Miro developer, we want to learn more about your motivations for building apps and the experiences you’ve had so far. Please complete our short survey and be in with the chance to win one of three $100 rewards.  Take the survey now ➡️ 

250
William Bishop
Mironeer
A
Alastair LeeNew Here
posted in Developer platform and APIs
Start numbering from X

I want to be able to type:An itemBut when I type that, Miro recognises that the 2 is a number and converts the text to a numbered list and changes the 2 to a 1.You can’t have a numbered list start with anything other than a 1.   

1250
A
Alexander Akhtyrtsev
Alexander AkhtyrtsevBeginner
posted in Developer platform and APIs
Boards picker for unregistered users "This board is private" issue.

Hello there,Having a problem with embedding Miro inside another iframe.It says “This is a private board”.I’ve submited the form to get access to boards picker component according to documentation.Here is the code:miroBoardsPicker.open({ clientId: clientId, action: 'access-link', allowCreateAnonymousBoards: true, getToken: async () => axios.post('/obtain-jwt').then(r => r.data), error: e => { console.log('on error', e) }, cancel: () => { console.log('on cancel') }, success: async function (result) { console.log(result) window.open(result.accessLink) }, }) It works well upon opening the access link in the separate window via window.open()Access Link example: https://miro.com/app/live-embed/uXjVMBMXOW0=/?boardAccessToken=5GDDy0S9quNzU4zH3U4jtsktWiJbpgKV&autoplay=trueHowever inside iframe some XHR requests falling with 403 error.​​​​​I noticed, that i

1247
Alexander Akhtyrtsev
A
Abhinav GuptaNew Here
posted in Developer platform and APIs
Custom shape widge as an app

Hi Guys I have a use case to create a custom shape widget on the Miro board where in a user can add one or more widget [ lets call it a card ]. Inside each card - I want to add some information in each tab and I can add or delete tabs ( rows ) as per the requirements. Widget should allow editing the information in each block.  Please visit this link to have a visual idea about the image - https://i.ibb.co/r6ssh6k/custom-widget.png I need your suggestions - How can I create this and use it on the development canvas board?  ThanksAbhinav 

931
Josip Janzic
Mironeer
U
Unleash QA1New Here
asked in Developer platform and APIs
An error occured while retrieving the subscription. Contact support to request assistance.

Hello community!I found a strange error going through logs, which is not reproducible so easily. The error message is “An error occurred while retrieving the subscription. Contact support to request assistance”, status is 400 and the code is “7.0913”.Does this happen to anyone and can any information be provided in order to understand the error ?Thanks in advance

272
U
M
MiroMiroMiroBeginner
posted in Developer platform and APIs
Interactive table with server connection

Hi, Looking around on the forum I could not find an answer to my question, so allow me to explain. For multiple groups of users we want to use miro boards for guiding their projects. In each step of the project, some data needs to be updated in a central database, to track the progress of the different projects. Since having all information in one place is benificial, we would like to have an interactive (excel-like) table, that on opening of the Miro board loads data from a (company) server, and allows people to enter/change information in the table. The information should then be updated on the server.Is this possible, even in a non-native way? If anything about my question is unclear, feel free to ask for more details.

4609
K
S
Steffen BeckerBeginner
posted in Developer platform and APIs
Jira Cards (DC) with OAuth 2.0

Hello,I struggle to install Jira Cards with our onprem Jira instance (DataCenter) using OAuth 2.0.What I read from Miro documentation is that OAuth 1.0 is used for onprem Jira instances.In the german version it is even said that:The protocol used is OAuth 1.0.Currently Atlassian only supports this protocol. OAuth 2.0 authorisation code (3LO) is currently in developer preview.https://help.miro.com/hc/de/articles/360013463739-Jira-Karten-FAQWhich is clearly untrue because our Jira instances (v9.x) uses OAuth 2.0 by default.That’s why the connection between Jira and Miro does not work for our instance, because Miro only supports OAuth 1.0. So my question is: How can I connect Miro to Jira (DC) - while Miro only supports OAuth 1.0 but Jira only supports OAuth 2.0?

930
S
S
Sathiamoorthy MBeginner
posted in Developer platform and APIs
Export board Image or PDF using API

Hi,How to export the miro board as Image, Pdf or any other format. Someone could please help me out, I need this feature.Regards,Sathia

128912
William Bishop
Mironeer
William Bishop
Mironeer
William BishopMironeer
posted in Developer platform and APIs
Developer Challenge: Where's Miro? Scavenger Hunt!

 Introducing our new Developer Challenge Hey, devs! Ready for a challenge?Check out the Miro Developer Platform's Web SDK Scavenger Hunt 🔎Level up and use Miro's Web SDK to interact with your boards, using just our built-in console. 🤖Get Started and earn a surprise developer badge:https://bit.ly/43dwkni

500
William Bishop
Mironeer
A
aurechBeginner
posted in Developer platform and APIs
Documentation/Type support - board.get() for connectors

Hey Nice to finally see the addition of connectors to the SDK (though the change from “Feature request” to “Done” on the roadmap was a little swift and unexpected).  To get to the point though: I  see thatboard.get({type:”connector”})is actually implemented - I can use it in the dev console for example to get only connectors.  But it would seem that the types package- & the documentation are not up to date with this fact?   So this right here produces a compiler error (although an easy workaround is to just cast it). 

654
Mira Balani
Mironeer
N
NataliMaRisNew Here
posted in Developer platform and APIs
The app panel does not appear to the other users of my team when I am collaborating in real time with them.

When several users are in the same board, they not see the left-side panel where the app is running. They can use the app independently, but it does not show them what the administrator is doing at the moment in his panel.For example, if I'm inserting a word into wordle app , they don't see the word that i am writting ,and they can´t insert a word. But if i add a sticky note they inmediately see it on the board and they can edit it.administrator :member:In the screenshot , both users are at the same time in the same board. Both see the board, but only one the panel app.The panel where the app that I have developed is running does not allow me to share it in real time with the other team members. My question is: is there any possibility that the panel where the app is running can be shared just like the board is shared?

181
William Bishop
Mironeer
L
LeonardoNew Here
posted in Developer platform and APIs
TypeError: board.createStickyNoteItem is not a function

Hey everyone, I’m following thishttps://developers.miro.com/docs/working-with-sticky-notes-and-tags-with-the-rest-api and after obtaining my oath for my app and plug that in the code, plus added the board id from https://miro.com/app/board/uXjXXXXXXXX/ where uXjXXXXXXXX(censored) is the board id and i get the following error:‘const sticky = await board.createStickyNoteItem({                           ^TypeError: board.createStickyNoteItem is not a function‘Complete code: // Using miro-api client libraryconst { MiroApi, ShapeItem } = require("@mirohq/miro-api");const api = new MiroApi('eyJtaXJvLm9yaWdpXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')const board = api.getBoard('uXjXXXXXXXX')async function main() {const sticky = await board.createStickyNoteItem({ data: { content: "I'm a sticky note", shape: "square", }, style: { fillColor: "light_yellow", textAlign: "center", textAlignVertical: "top", }, position: { x: 0, y: 0, },})}main()  I think the issue is wit

732
Mira Balani
Mironeer
M
Manjunatha CitragarNew Here
posted in Developer platform and APIs
Live Embed Miro Board Events

Hi Team,        Is there a way to capture user interactions with Live embed Miro board? I want to  capture the those events and replay them later re-creating entire interaction with the board programmatically.  Thank you

231
William Bishop
Mironeer
Christophe GESCHÉ
Christophe GESCHÉExperienced Community Member
posted in Developer platform and APIs
why did you choose such a complicated paging operation ?

 I understand the need to force a pagination (although 100; it's still a bit low.)But then the stroke of the cursor, I do not understand.Could a simple "offset" have been suitable?Limit=100&offset=0, Limit=100&offset=100, Limit=100&offset=200, … In any case, it complicates my work terribly.Maybe making access difficult and complicated is a way to reduce the load on api servers.

13610
Mira Balani
Mironeer
P
pholzNew Here
posted in Developer platform and APIs
How to change the order of the presentation frames using Web SDK?

I use an async call to create a number of frames with `createFrame()`. When I go into “Presentation Mode” in the UI, the order seems random (or influenced by the async call). Using the UI sidebar, I can of course change the order. How can I do this programmatically? Is there a property such as `presentationOrder` for frames?

261
Mira Balani
Mironeer
S
SiegmarBeginner
posted in Developer platform and APIs
Call an external API from Web SDK

Hi,I am testing Miro REST API and WEB SDK and, so far, everything is woring fine.My current test is calling an external API from WEB SDK App, but it is not working.Is the ( API call ) code below valid for Miro ?It works perfectly well in a normal React site.As you can see in the code this example uses a non-authenticated and CORS enabled URI.Thanksimport * as React from 'react';import {createRoot} from 'react-dom/client';import { useState, useEffect } from 'react'; // APIasync function addSticky() { const [data, setData] = useState(null); useEffect(() => { fetch("https://contabo.easylob.com:5443/echo?origin=Miro") .then(response => response.json()) .then(json => setData(json)) .catch(error => console.error(error)); }, []); const stickyNote = await miro.board.createStickyNote({ content: 'Hello, World!', }); await miro.board.viewport.zoomTo(stickyNote);}const App = () => { React.useEffect(() => { addSticky(); }, []); return ( ... );}

2128
Mira Balani
Mironeer
Marco Spinello
Mironeer
Marco SpinelloMironeer
posted in Developer platform and APIs
Miro Web SDK 2.0 introduces flowchart shapes, getOnlineUsers, online_users:updates

Good day Miro developers! 🖖 😃  The Miro Web SDK 2.0 got a couple of new features 🚀 that we’d love to share with you! 💫Flowchart shapes are now available as an additional set of shapes in the experimental shape item. ℹ️ Currently, flowchart shapes are available only in the experimental namespace: miro.board.experimental.   getOnlineUsers: how many users are currently online on a board? Use the getOnlineUsers method to fetch IDs and names of currently online users on a board.   online_users:update: apps can subscribe to the online_users:update event to register changes in the number of online board users. The event contains an array with user IDs and names of the currently online users.For more details and for links to the docs, see the changelog 📄

571
Max Harper
T
Tom DenbyBeginner
posted in Developer platform and APIs
npm run start

this is the first miro app i’ve tried to create, so im following the webinar here -  when i run npm run start  i get the following error,  npm ERR! Missing script: "start" seems like probably a basic error but i’ve not had it before on other solution i’ve developed, any ideas how to resolve it? 

2016
T
S
SiegmarBeginner
posted in Developer platform and APIs
Miro Web SDK App with Python and Flask

Hi,I just published a Medium Story and a GitHub repository with a Web SDK App created with Python and Flask, instead of JavaScript and React:Medium - Miro Web SDK App with Python and FlaskGitHub - MiroSo far I did not see any incompatibility with Python, but I will continue the tests.Next steps are including Business Logic, API and OAuth 😀Thanks ( you may close the Conversation )

3121
S
Terms & Conditions