These steps allow you to interact with Miro's online whiteboard.
- MiroOnlineWhiteboard.zip - Workflow zip file with the step and example flow
- miro.png - Miro logo
These steps use the Miro API to create boards and post to boards.
You need a Miro account for this integration.
- You'll need to generate an API token from your Miro account.
- Follow the steps here (https://developers.miro.com/docs/getting-started) to get your Token. The permissions
boards:readandboards:writeshould be suitable for the xMatters steps. - Copy the created token for use in the xMatters Steps.
- Download the MiroOnlineWhiteboard.zip file onto your local computer
- Navigate to the Workflows tab of your xMatters instance
- Click Import, and select the zip file you just downloaded
- Create an endpoint for Miro that uses Basic Authentication (username and password from Miro). The endpoint should have the base URL
https://api.miro.com. - Create a constant for the token you copied during the Miro Setup.
The steps are now available for use in a workflow.
| Name | Required? | Min | Max | Help Text | Default Value | Multiline |
|---|---|---|---|---|---|---|
| BoardName | No | 0 | 200 | Name of board to create. | No | |
| sharingPolicy-access | No | 0 | 200 | sharingPolicy.access can be private, view, comment | view | No |
| sharingPolicy-teamAccess | No | 0 | 2000 | sharingPolicy.teamAccess can be private, view, comment, edit | No | |
| token | No | 0 | 2000 | Grab your account API token | No |
| Name | Description |
|---|---|
| response | Response message. |
| boardId | ID of the board created. |
| viewLink | Link to the board for viewing in browser. |
| Name | Required? | Min | Max | Help Text | Default Value | Multiline |
|---|---|---|---|---|---|---|
| BoardId | No | 0 | 200 | ID of the board to add to. | No | |
| type | No | 0 | 200 | This endpoint currently supports next widget types: card, sticker, text, shape, line. | Sticker | No |
| text-title | No | 0 | 2000 | Title of the card (typically incident number) | No | |
| token | No | 0 | 2000 | Grab your account API token | No | |
| text-detail | No | 0 | 2000 | Detail message content | No |
| Name | Description |
|---|---|
| response | Response from Miro. |
This is what the provided flow with the steps looks like.
