Developer platform and APIs

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

  • 805 Topics
  • 2,599 Replies

805 Topics

P
PolinaNew Here
posted in Developer platform and APIs

Adding Tags to the cards via API

Hi Miro Team,I was looking to create an app that will allow to create cards automatically from a CSV file. And looking at the API docs I saw that card got only these fields: title, desc, date, assignee. Can Tag field be added to a cardusing the API?

1
Max Harper
2 years ago
R
RamBeginner
asked in Developer platform and APIs

Export the board from iframe

Hey @allWe use the paid Miro api on our site. The board is very nice, is working good . Now we have created the export button on our site. If you click on the button, the current Miro board is download .. How to do it?Is anything possible for that?How do we change our code? Note: This is an external function. We do not use the default export option inside the board Thanks,G Ramkumar

1
Anthony Roux
Mironeer
2 years ago
B
Bogdan KosarevNew Here
posted in Developer platform and APIs

Web Plugin not working

Hi all!I made a simple web-plugin and all was fine. But some time ago it stops working. In console log I see such messages: Access to fetch at 'https://miro.com/api/v1/users/<id>' from origin '<my server host>' has been blocked by CORS policy: No 'Access-Control-Allow-Origin' header is present on the requested resource. If an opaque response serves your needs, set the request's mode to 'no-cors' to fetch the resource with CORS disabled.I definitely haven't made any changes to either the plugin code or my server settings. Can you tell me if there have been any changes in Miro in this regard?Thanks!

1
Anthony Roux
Mironeer
2 years ago
W
Wender XavierBeginner
posted in Developer platform and APIs

WIDGETS_TRANSFORMATION_UPDATED event not working for type: LINE

Hello,I'm having an issue when listening for the WIDGETS_TRANSFORMATION_UPDATED event.All widgets trigger this event on change (shapes, text, stickers, etc) except for the LINES.If you update a line alone, it does not trigger this event, however, if you update together a line and a shape, it does show the line on the data array.Example of the event working for a TEXT widget. 

1
Anthony Roux
Mironeer
2 years ago
Sami Ljimari
Sami LjimariActive Contributor
posted in Developer platform and APIs

'zoomToObject' is deprecated api. It will be removed soon.

As stated in the title, 'zoomToObject' is deprecated api. It will be removed soon. pops up in console everytime I use the “await miro.board.viewport.zoomToObject(widgetID);” command.  It is nice that you warn users that a certain functionality will be removed, but some insight as to why this would be removed and maybe what will replace this functionality and when would be welcomed too, because right now I cannot find any other suitable command which could replace zoomToObject in my app.  Maybe keeping a update log page with scheduled updates including scheduled API changes would help, or generally just some form of communication and updates about API issues, like updating metadata  which has been now broken for over a month. 

1
Anthony Roux
Mironeer
2 years ago
U
UmapathyNew Here
asked in Developer platform and APIs

How to get your Client ID approved from Miro ?

Hi, I am working on integrating Miro to our web app, it has been said, we need to send our client ID to Miro to get approval, Please guide me through to which mail id, should this be sent ThanksUmapathy

1
Anthony Roux
Mironeer
2 years ago
A
anupam UJJWALNew Here
asked in Developer platform and APIs

Custom Notifications for MIRO board

I wan to show a custom message bar on top of all the board across my team. I can push a message on the board through web plugin using showNotification() method but if I use method, the notification disappears after few seconds.I want to ensure this message never disappears from the board and every time user open the board, this message is visible. What's the best way of achieving this.

1
Anthony Roux
Mironeer
2 years ago
Kenneth Chen
Kenneth ChenBeginner
asked in Developer platform and APIs

Listen to childrenId change in frames

Hello!I’m currently working on a plugin that tries to simulate some type of real time update behavior. I.e. when I add, modify, or delete some sticky notes inside a frame, it will trigger some action somewhere else. To all the Miro and JS experts out there: I’m wondering if there’s a way to listen for a change in the frame’s children and react to it?The only way I can think of is leveraging the existing Miro SDK listeners so that every time a sticky note is created, it will check every relevant frame and see if the sticky note is inside one of them. I’m just a little concerned that this method won’t scale well.Thank you in advance for your answers!

1
Anthony Roux
Mironeer
2 years ago
C
Constantinos PaphitisNew Here
posted in Developer platform and APIs

Create Overflow plugin for Miro

Looking for some guidance.  I am on an internship and have been asked to look into a way Miro can add flow diagram projects from Overflow.  What i want to do is to add projects from Overflow as you would do with the already available plugin for Adobe XD.  The idea is to provide collaboration on Overflow projects.  Any assistance to point me in the right direction will be greatly appreciated.

1
Anthony Roux
Mironeer
2 years ago
R
RodhappiNew Here
asked in Developer platform and APIs

SDK + Typescript 👉 Unable to get Props like "Text" from Widget

Hi,I’ve just started to code a react app with typescript and I’m struggling with getting some props (ex. “Text”) from interfaces like IStickerWidget which extends IWidget. interface IWidget extends IWidgetNamespaces { readonly id: string readonly type: string readonly bounds: IBounds readonly groupId?: string readonly createdUserId: string readonly lastModifiedUserId: string }Here is the scenario: 1️⃣ I’m using the type declaration miro.d.ts. 2️⃣ Here is the snippet code where:1) I get the widgets selected (through the SDK IBoardSelectionCommands and its get() method),2) filter by type (STICKER) and3) then try to get again the specific widget, but through the get command from IBoardWidgetsCommands this time, as I thought the SDK was going to return an IStickerWidget type base on the filterby id.let selectedWidgets:SDK.IWidget[] = await miro.board.selection.get()let selectedStickers:Array<SDK.IWidget> = selectedWidgets.filter((widget) => widget.type ==

1
Anthony Roux
Mironeer
2 years ago
A
Anton AbramovNew Here
asked in Developer platform and APIs

Boards Picker Component Does not work on localhost

I am trying to execute Boards Picker API locally .code:clientId : 3074457360836196477but getting Sorry, integration is unavailable.Error. Account is not a partner. Reason is accountIsNotPlatformPartnerI also added localhost and 127.0.0.1 in Boards Picker domains list at app dashboard.But did not help.

1
Anthony Roux
Mironeer
2 years ago
D
Dominic NguyenNew Here
asked in Developer platform and APIs

Image Plugin API

Hello, I’m trying to upload an image widget via the REST api. I can see some references to https://miro.com/api/v1/boards/<boardId>/integrations/imageplugin using a hash authentication, but nothing on the documentation. Is there an equivalent in the published API? Many thanks

1
Max Harper
2 years ago
R
Ravi KishanNew Here
posted in Developer platform and APIs

Regarding User management in API

Does miro provide user management through API.I found i can Invite a user and read a user.But didn’t find anything for updating and deleting.  

1
Anthony Roux
Mironeer
2 years ago
D
Dustin BuetlerNew Here
asked in Developer platform and APIs

block text work-around

Dear All As far as i know is it only possible to choose from three kinds of text-block styles. I was wondering if there is a work-around to manually make block texts (the vey square ones), like the ones you can select in Word for instance.  Would be very Thankful for any advice,Dustin

1
mlanders
2 years ago
T
Tim AltendorfNew Here
asked in Developer platform and APIs

Get boards by Project

Hi!Is there a way to get only the boards grouped in a certain Project via the Rest API?  

1
Anthony Roux
Mironeer
2 years ago
A
annie.maria_extBeginner
asked in Developer platform and APIs

Miro API to delete a user from a board

I need to sync between access in MS teams and Miro. My use case is similar to  this link : Add and remove users (miro.com), but the endpoints are deprecated now.I just wanted to check, if there an endpoint to remove the users from a board, if so could I please get the details of that .

1
Anthony Roux
Mironeer
2 years ago
A
Alyan SanievBeginner
asked in Developer platform and APIs

admin_rules _ access token

Hi.I got an access token to use Api for collecting Audit logs.My account has the role of company administrator.If my account is deprived of the administrator role, will the token work? for getting logs?Thank you.

1
Anthony Roux
Mironeer
2 years ago
M
manavb1Beginner
asked in Developer platform and APIs

Migrating from getToken() to getIdToken()

I’m unsure how to go about migrating from getToken() to getIdToken(), currently I have this code to make a request to my Api. const appId = miro.getClientId(); const clientId = appId.toString(); let token = await miro.getToken(); let boardInfo = await miro.board.info.get(); let teamInfo = await miro.account.get(); console.log(token) return this.makeCall(() => fetch(`${this.baseUrl}/${clientId}/team/${teamInfo.id}/JiraCard/board/${encodeURIComponent(boardInfo.id)}`, { method: 'POST', headers: { 'Authorization': 'Bearer ' + token, 'Content-Type': 'application/json' }, body: JSON.stringify({ "issueKey": issueKey, "x": x, "y": y }) }), (successResponse) => successResponse.json())If I replace getToken() with getIdToken() the OAuth Token is invalid, as getIdToken() returns a different type of token. How exactly do I go about decod

1
Anthony Roux
Mironeer
2 years ago
R
RamBeginner
asked in Developer platform and APIs

Whiteboard Integration on our site

 Hi.., How to use our site for Miro whiteboard. We looked at the API document, but are still confused. Is it possible to integrate with the Miro whiteboard on our site?ORIf there is any paid version, please send details and how to integrate the Miro whiteboard application into my Laravel code? Thanks,G. Ramkumar

1
Anthony Roux
Mironeer
2 years ago
Falk Kühnel
Falk KühnelActive Contributor
asked in Developer platform and APIs

How can i find out, if one widget is in front of another?

Hi! Is there a way to find out, if a widget is in front of another widget? ThanksFalk

1
Anthony Roux
Mironeer
2 years ago
M
manavb1Beginner
posted in Developer platform and APIs

Property 'requestAuthorization' does not exist on type 'Root'.

I am trying to migrate to miro.requestAuthorization, but I get the above error. Anyone know how to fix it?

1
Anthony Roux
Mironeer
2 years ago
M
manavb1Beginner
asked in Developer platform and APIs

Type 'undefined' is not assignable to type 'Promise'.

I am trying to add a button to the context menu for widgets, here is the code: miro.onReady(async (): Promise<void> => { miro.initialize({ extensionPoints: { getWidgetMenuItems: (widgets) => { if (widgets[0]['type'] === 'CARD') return [{ tooltip: 'Estimate', svgIcon: '<circle cx="12" cy="12" r="9" fill="none" fill-rule="evenodd" stroke="currentColor" stroke-width="2"/>', onClick: async (widgets) => { await jiraCard() } }] } }, });})Unfortunately, this gives me the error       TS2322: Type '(widgets: IWidget[]) => { tooltip: string; svgIcon: string; onClick: (widgets: any) => Promise<void>; }[] | undefined' is not assignable to type '(widgets: IWidget[], editMode: boolean) => Promise<IWi

1
Anthony Roux
Mironeer
2 years ago
M
MonitorNew Here
asked in Developer platform and APIs

How can I create rest api app and use it in enterprise account?

Hi. I have application tested in my personal account in dev-team. But then i signed to enterprise account, I can’t create a dev-team and create any rest api configuration. I received a message during dev team creation - Domain users are not allowed to create any account outside of their domain organization.Domain admin is ready to provide any rights, but how can it be done? 

1
Rich Moore
Mironeer
2 years ago
R
RamkumarBeginner
posted in Developer platform and APIs

Create image widget with Data URL

Hi, Is it possible to create image widget with data URL such as data:image/jpeg;base64,/9j/4…When I attempt to do so it throws error Error: 'url' field is required for ImageWidget Regards,Ram

1
Max Harper
2 years ago
Alex Dobson
Alex DobsonNew Here
asked in Developer platform and APIs

Miro Embed Boards For Non Registered Users - How To Join Board

Hi,We’re using the “Editable boards for not registered users” as per the docs: here.Following the docs we’re able to get the embed boards to function without having to sign in as desired.However, we’re unsure how to connect multiple users to the same board, or return the same user to a board after leaving and returning. How might we do this? Is there a way to specify the board ID to connect to? Or something along those lines. Obviously for a collaborative tool like miro, it’s quite critical that we have multiple users connect to the same board.It’s mentioned that the boards for anonymous users are destroyed after 24 hours, which to me implies that there must be a way to return to the board. Thank you!

1
Anthony Roux
Mironeer
2 years ago
Terms & Conditions