Connectors / Service / Miro

Miro

Miro

Miro is an intuitive and powerful email marketing service.

Overview

Miro is an online collaborative whiteboarding platform that enables distributed teams to work effectively together. Its services include brainstorming with digital sticky notes to planning and managing agile workflows, workshopping, strategy mapping, UX research and design, product development, customer discovery, and process visualization.

API INFO: The Base URL used for the Miro connector is https://api.miro.com/. More information can be found on their main API documentation (v1.0) site.

Authentication

When using the Miro connector, the first thing you will need to do is go to your Tray.io account page, and select the workflow you wish to work on. Once in the workflow builder itself, search and drag the Miro connector from the connectors panel (on the left hand side) onto your workflow.

With the new Miro connector step highlighted, in the properties panel on the right, click on the Authenticate tab and 'Add new authentication' (located under the 'Authentication' field).

This will result in a Tray.io authentication pop-up window. The first page will ask you to name your authentication, and state which type of authentication you wish to create ('Personal' or 'Organisational').

As you can see, the next page asks you to select which permissions you want to grant the service.

Once you have selected the scopes you wish to grant, click the 'Create authentication' button. You will automatically be redirected to Miro's login page. Use your Miro credentials to log in

After logging in to your Miro account, you will be shown the scopes that the service is requesting. These are the same scopes that you have recently selected from the authentication modal on the Tray platform. After you have confirmed these scopes, click the 'Install' / 'Reinstall' button available on the bottom right.

Go back to your settings authentication field (within the workflow builder properties panel), and select the recently added authentication from the dropdown options now available.

Your connector authentication setup should now be complete.

Available Operations

The examples below show one or two of the available connector operations in use.

Please see the Full Operations Reference at the end of this page for details on all available operations for this connector.

Using the Raw HTTP Request ('Universal Operation')

As of version 1.0, you can effectively create your own operations.

This is a very powerful feature which you can put to use when there is an endpoint in Miro's API, which is not used by any of our operations.

To use this you will first of all need to research the endpoint in the Miro REST API reference documentation, to find the exact format that Miro will be expecting the endpoint to be passed in.

Note that you will only need to add the suffix to the endpoint, as the base URL will be automatically set (the base URL is picked up from the value you entered when you created your authentication).

The base URL for Miro is: https://api.miro.com/v1

For example, say that the 'Get board' operation did not exist in our Miro connector, and you wanted to use this endpoint, you would use the Miro API docs to find the relevant endpoint - which in this case is a GET request called: /boards/{id}, with '{id}' referring to the ID of the board that you want to retrieve.

More details can be found here.

As you can see there is also the option to include a query parameter, should you wish to do so. So if you know what your method, endpoint and details of any potential query parameters are, you can get information about a specific board with the following settings:

Method: GET

Endpoint: /boards/{id} (replace '{id}' with the actual ID of the board you want to fetch).

Body Type: None

Final Example outcome being: https://api.miro.com/v1/boards/{id} (again, with '{id}' being replaced by the actual ID of the board you want to fetch - 1234 in this example).

Example usage

TRAY POTENTIAL: Tray.io is extremely flexible. By design there is no fixed way of working with it - you can pull whatever data you need from other services and work with it using our core and helper connectors. This demo which follows shows only one possible way of working with Tray.io and the Miro connector. Once you've finished working through this example please see our Introduction to working with data and jsonpaths page and Data Guide for more details.

Below is an example of a way in which you could potentially use the Miro connector to get the details of all widgets on a specific board.

The steps will be as follows:

  1. Setup using a manual trigger and list the widgets on a specific board.
  2. Add Loop collection step to iterate through each widget.
  3. Get the details of each widget.

The final outcome should look like this:

1 - Setup Trigger & list widgets

Once you have clicked 'Create new workflow' from your main Tray.io dashboard named it, select the Manual trigger from the trigger options available:

After you have been redirected to the Tray.io workflow dashboard, from the connectors panel on the left, add a Miro connector to your second step. Set the operation to 'List widgets' and enter the Board ID for the board you want to retrieve.

Please feel free to re-name your steps (perhaps after their operational names, as in the demo) as you go along to make things clearer for yourself and other users.

When run, the workflow will provide a list of widgets available on the specified board.

2 - Loop Collection

Next, search for the 'Loop collection' connector within your connector panel, and drag it into your workflow as your next step. Set your operations to 'Loop list'.

The Loop Collection connector allows you to iterate through a list of results. In this example, we will use it to iterate through the list of widgets from the previous Miro connector step.

In order to specify the list you want to loop through, start by using the 'List' mapping icon (found next to the list input field, within the properties panel) to generate the connector-snake.

While hovering over the 'List widgets' step (with the tail end of the connector-snake), select data from the list of output properties displayed. This will auto-populate a jsonpath within your 'List' input field ($.steps.miro-1.data, in this example), and update the type selector to jsonpath.

For more clarification on the pathways, you have available, open the Debug panel to view your step's Input and Output.

JSONPATHS: For more information on what jsonpaths are and how to use jsonpaths with Tray.io, please see our Intro page and Data Guide for more details.
CONNECTOR-SNAKE: The simplest and easiest way to generate your jsonpaths is to use our feature called the Connector-snake. Please see the main page for more details.

When run, the workflow will provide a list of widgets available on the specified board and then simply iterate over each widget in the returned list.

3 - Get widgets

The last step is to drag a final Miro connector inside of the actual Loop Collection step itself. Set the operation to 'Get widget'. As you can see, both the 'Board ID' and 'Widget ID' fields are required.

In the 'Board ID' field on the properties panel, enter the same board ID you entered in the 'List widgets step'.

Using the connector-snake, find the jsonpath for the 'Widget ID' from the previous step. It should appear similar to $.steps.loop-1.value.id.

When run, the workflow will provide a list of widgets available on the specified board and then simply iterate over each widget in the returned list and then retrieve each widget's details on the specified board.

If the workflow doesn't work as desired, click on the 'Debug' tab to inspect your logs and see if you can find the problem.

All Operations

Latest version:

1.0