Microsoft Planner Block
Read and create tasks in Microsoft Planner
The Microsoft Planner block integrates Planner task management into your workflow. Use it to read all of your tasks, tasks from a specific plan, or an individual task, and to create new tasks with properties like title, description, due date, and assignees using OAuth authentication.
Overview
| Property | Value |
|---|---|
| Type | microsoft_planner |
| Category | tools |
| Color | #E0E0E0 |
When to Use
- Create a new Planner task in a plan as part of an automated workflow.
- Read a specific task by ID to pull its current details into downstream steps.
- Fetch all tasks within a given plan to summarize or process them.
- Retrieve all of the authenticated user's tasks across plans.
- Assign newly created tasks to a user and set due dates programmatically.
- Organize created tasks into a specific bucket within a plan.
Configuration
Operation
Choose the action to perform. This selection determines which additional fields are displayed.
| Label | ID |
|---|---|
| Read Task | read_task |
| Create Task | create_task |
Microsoft Account
OAuth credential used to authenticate against Microsoft Planner via the microsoft-planner provider. Required scopes: openid, profile, email, Group.ReadWrite.All, Group.Read.All, Tasks.ReadWrite, offline_access.
Plan ID
The ID of the Planner plan to operate on. Shown for both read_task and create_task. For read operations it is optional — when supplied, all tasks from that plan are returned; when omitted together with Task ID, all tasks assigned to the authenticated user are returned. For create operations it is required.
Task ID (basic mode)
Available for read_task only. A file-selector picker (basic mode) that lets you choose a task interactively from the connected Microsoft Planner account.
Manual Task ID (advanced mode)
Available for read_task only. A free-text input (advanced mode) for entering a task ID directly. When provided, it takes priority over Plan ID and returns a single specific task.
Task Title
The title of the task to create. Required for create_task.
Description
An optional long-form description for the task being created. Shown only for create_task.
Due Date
An optional due date/time for the task in ISO 8601 format (e.g., 2024-12-31T23:59:59Z). Shown only for create_task.
Assignee User ID
Optional. The Azure AD user ID of the person the task should be assigned to. Shown only for create_task.
Bucket ID
Optional. The ID of the bucket (column) within the plan where the task should be placed. Shown only for create_task.
Inputs & Outputs
- Inputs:
operation(string) — Operation to perform (read_taskorcreate_task)credential(string) — Microsoft account OAuth credentialplanId(string) — Plan ID (required forcreate_task; optional forread_task)taskId(string) — Task ID (forread_task; overridesplanIdwhen set)title(string) — Task title (required forcreate_task)description(string) — Task description (optional,create_taskonly)dueDateTime(string) — Due date in ISO 8601 format (optional,create_taskonly)assigneeUserId(string) — Azure AD user ID to assign the task to (optional,create_taskonly)bucketId(string) — Bucket ID within the plan (optional,create_taskonly)
- Outputs:
task(json) — The Microsoft Planner task object, including details such as id, title, description, status, due date, and assigneesmetadata(json) — Additional metadata about the operation, such as timestamps, request status, or other relevant information
Tools
Read Microsoft Planner Tasks (microsoft_planner_read_task) — Reads tasks from Microsoft Planner via the Microsoft Graph API. Retrieves a single task when taskId is provided, all tasks from a specific plan when planId is provided, or all tasks assigned to the authenticated user when neither is supplied.
Create Microsoft Planner Task (microsoft_planner_create_task) — Creates a new task in Microsoft Planner via the Microsoft Graph API. Requires planId and title; optionally accepts description, dueDateTime, assigneeUserId, and bucketId.
YAML Example
planner_create:
type: microsoft_planner
name: "Microsoft Planner"
inputs:
operation: "create_task"
credential: "{{MICROSOFT_PLANNER_CREDENTIAL}}"
planId: "AAkALgAAAAAAHYQDEapmEc2byACkI8OwAA"
title: "Follow up with customer"
description: "Reach out about the renewal"
dueDateTime: "2024-12-31T23:59:59Z"
assigneeUserId: "{{user_lookup_1.userId}}"
bucketId: "BnD4zqJ5xUiZbPz8bHMWGmQAGGwn"
connections:
outgoing:
- target: next-block-id