Miro

Comprehensive guide to the Miro node in StackAI: discover key actions, input requirements, configurations, and output examples for seamless Miro integration.

What is Miro?

The Miro node in StackAI enables seamless integration with the Miro collaborative whiteboard platform. It allows you to automate board management, content creation, and team collaboration directly from your StackAI workflows.


How to use it?

To use the Miro node, select the desired action, provide the required inputs and configurations, and connect your Miro account using a valid connection ID. The node can be used to automate board creation, manage content, and interact with Miro items programmatically.


Example of Usage

Suppose you want to automatically create a new Miro board for every new project. You would use the "Create Board" action, provide the board name as input, and optionally set a description or team ID. The output will include the board's unique ID and URL, which you can use in subsequent workflow steps.


Available Actions

Below are the most commonly used Miro actions in StackAI, along with their input, configuration, and output details:


1. Create Board

Description: Create a new Miro board in your workspace.

Inputs:

  • name (Required): The name of the new board. Example: "Project Kickoff Board"

  • description (Optional): A description for the board. Example: "Board for the new project kickoff meeting."

  • team_id (Optional): The ID of the team to assign the board to. Example: "345678"

Configurations:

  • connection_id (Required): Your Miro connection ID for authentication.

Outputs:

  • id (Always returned): The unique identifier of the created board.

  • name: The name of the board.

  • description: The board description.

  • viewLink: The URL to access the board.


2. Get Boards

Description: Retrieve a list of all boards accessible to your account.

Inputs:

  • team_id (Optional): Filter boards by team ID.

Configurations:

  • connection_id (Required): Your Miro connection ID.

Outputs:

  • boards: An array of board objects, each containing:

    • id: Board ID

    • name: Board name

    • description: Board description

    • viewLink: Board URL


3. Create Sticky Note Item

Description: Add a sticky note to a specific Miro board.

Inputs:

  • board_id (Required): The ID of the board to add the sticky note to.

  • data (Required): The content/text of the sticky note. Example: "Discuss project milestones"

Configurations:

  • connection_id (Required): Your Miro connection ID.

Outputs:

  • id: The unique identifier of the sticky note.

  • data: The content of the sticky note.

  • position: The coordinates of the sticky note on the board.


4. Get Board

Description: Retrieve details of a specific Miro board.

Inputs:

  • board_id (Required): The ID of the board.

Configurations:

  • connection_id (Required): Your Miro connection ID.

Outputs:

  • id: Board ID

  • name: Board name

  • description: Board description

  • viewLink: Board URL


5. Create Shape Item

Description: Add a shape (rectangle, circle, etc.) to a Miro board.

Inputs:

  • board_id (Required): The ID of the board.

  • shape (Required): The type of shape (e.g., "rectangle", "circle").

  • text (Optional): Text to display inside the shape.

Configurations:

  • connection_id (Required): Your Miro connection ID.

Outputs:

  • id: Shape item ID

  • shape: Type of shape

  • text: Text inside the shape

  • position: Coordinates on the board


Best Practices:

  • Always provide a valid connection ID for authentication.

  • Use required inputs as specified for each action to avoid errors.

  • Use the output IDs to reference created items in subsequent workflow steps.


Summary Table

Action
Required Inputs
Optional Inputs
Output Highlights

Create Board

name

description, team_id

id, name, viewLink

Get Boards

team_id

boards[]

Create Sticky Note Item

board_id, data

id, data, position

Get Board

board_id

id, name, viewLink

Create Shape Item

board_id, shape

text

id, shape, position


Use the Miro node in StackAI to automate and streamline your collaborative workflows, making project management and team collaboration more efficient.

Last updated

Was this helpful?