Web-plugins are a fast and easy way to create your own tools within Miro. With web-plugins you can add buttons to toolbars, render custom views in modals and sidebars, and modify objects on the board.
Web-plugins are JS scripts that run on boards in isolated iframes. The JS code of a web-plugin communicates with the Miro application via PostMessage using the Miro SDK.
See the SDK Reference here.
Web-plugins can change the board content on behalf of the current user. A user must authorize a web-plugin via OAuth2.
The permissions and capabilities of a web-plugin are defined by scopes, just as with the REST API. You must enable the required scopes in your application settings. When you enable a scope, each user has to grant your app the associated permissions.
boards:read — Read boards the user has access to
miro.board.widgets.get() miro.board.comments.get() miro.board.groups.get() miro.board.selection.get() miro.board.selection.selectWidgets()
boards:write — Modify boards the user has access to
miro.board.widgets.create() miro.board.widgets.update() miro.board.widgets.transformDelta() miro.board.widgets.deleteById() miro.board.widgets.bringForward() miro.board.widgets.sendBackward()
Updated over 1 year ago