Microsoft Planner Connector
Manage plans, buckets, tasks, and task details in Microsoft Planner.
Connections
OAuth 2.0 Authorization Code
Authenticates actions in all Microsoft's Graph API services.
This connection uses OAuth 2.0, a common authentication mechanism for integrations. Read about how OAuth 2.0 works here.
| Input | Comments | Default |
|---|---|---|
| Base URL | The base URL for the Microsoft Graph API. Depending on your cloud environment, you can choose the correct one here. | https://graph.microsoft.com |
| Tenant URL | The tenant URL for the Microsoft Graph API. This is the URL of the tenant that you are connecting to. You can find this in the Azure portal or here. | login.microsoftonline.com/common |
| Scopes | Space-separated Microsoft Graph scopes. Tasks.ReadWrite covers all Planner reads and writes and offline_access is required to receive a refresh token. Add Group.Read.All to list every group in the tenant rather than only the groups the signed-in user belongs to. | https://graph.microsoft.com/Tasks.ReadWrite https://graph.microsoft.com/User.Read https://graph.microsoft.com/User.ReadBasic.All offline_access |
| Client ID | Client Id of your Azure application. | |
| Client secret value | Client Secret generated under 'Certificates & Secrets' in your Azure application. | |
| Additional Authorization Parameters | Query string parameters to append to the OAuth authorization URL. Common parameters include prompt=consent to force the consent screen or login_hint=user@example.com to pre-fill the login email. |
OAuth 2.0 Client Credentials
Authenticates actions in all Microsoft's Graph API services.
This connection uses OAuth 2.0, a common authentication mechanism for integrations. Read about how OAuth 2.0 works here.
| Input | Comments | Default |
|---|---|---|
| Base URL | The base URL for the Microsoft Graph API. Depending on your cloud environment, you can choose the correct one here. | https://graph.microsoft.com |
| Microsoft Entra ID Endpoint | The Microsoft Entra ID endpoint for the Microsoft Graph API. You can find this in the Azure portal or here. | https://login.microsoftonline.com |
| Tenant | Tenant ID or primary domain, found on the Overview page of the Microsoft Entra admin center. A client credentials token cannot be issued against the 'common' endpoint, so a specific tenant is required here. | |
| Client ID | Client Id of your Azure application. | |
| Client Secret | Client Secret generated under 'Certificates & Secrets' in your Azure application. | |
| Scopes | Microsoft Graph API Scopes. | https://graph.microsoft.com/.default |
| User ID | Object ID or user principal name of the user whose Planner data is accessed, found in the Microsoft Entra admin center under Users. Required because a client credentials token has no signed-in user, so every /me path is rewritten to /users/{User ID}. |
Triggers
New Tasks
Retrieves existing and newly created tasks for a specified Microsoft Planner plan. Load history once, check for new tasks on a schedule, or both.
| Input | Comments | Default |
|---|---|---|
| Connection | The Microsoft Planner connection to use. | |
| Group ID | The Microsoft 365 group whose plans populate the Plan ID dropdown. Only Microsoft 365 groups can hold Planner plans. Leave blank to list the plans shared with the connection's user instead. | |
| Plan ID | The unique identifier of the plan. | |
| Look-back Date | The date the initial sync starts from, in YYYY-MM-DD format. Cannot be a future date. Leave empty to start from the first recurrence with no backfill. When set, the initial sync seeds each task created on or after this date once. |
Actions
Assign Task
Add or remove the users assigned to a task.
| Input | Comments | Default |
|---|---|---|
| Connection | The Microsoft Planner connection to use. | |
| Group ID | The Microsoft 365 group whose plans populate the Plan ID dropdown. Only Microsoft 365 groups can hold Planner plans. Leave blank to list the plans shared with the connection's user instead. | |
| Plan ID | The unique identifier of the plan. | |
| Task ID | The unique identifier of the task. | |
| Assignment | Users to assign or unassign. At least one of Assign To or Unassign is required. | |
| Assign To | Users to assign to the task, identified by object ID. Existing assignees that are not listed here are left in place. | [] |
| Unassign | Users to remove from the task, identified by object ID. | [] |
| ETag | The last known ETag of the resource being changed. Leave blank to let the action read the current ETag before writing. Supply a value to make the change conditional on that exact version, which fails with a conflict if the resource changed. |
Complete Task
Mark a task as complete.
| Input | Comments | Default |
|---|---|---|
| Connection | The Microsoft Planner connection to use. | |
| Group ID | The Microsoft 365 group whose plans populate the Plan ID dropdown. Only Microsoft 365 groups can hold Planner plans. Leave blank to list the plans shared with the connection's user instead. | |
| Plan ID | The unique identifier of the plan. | |
| Task ID | The unique identifier of the task. | |
| ETag | The last known ETag of the resource being changed. Leave blank to let the action read the current ETag before writing. Supply a value to make the change conditional on that exact version, which fails with a conflict if the resource changed. |
Create Bucket
Create a bucket in a plan.
| Input | Comments | Default |
|---|---|---|
| Connection | The Microsoft Planner connection to use. | |
| Group ID | The Microsoft 365 group whose plans populate the Plan ID dropdown. Only Microsoft 365 groups can hold Planner plans. Leave blank to list the plans shared with the connection's user instead. | |
| Plan ID | The unique identifier of the plan. | |
| Name | The name of the bucket, shown as a column heading on the plan's board. |
Create Plan
Create a plan inside a Microsoft 365 group. The caller must already be a member of that group; creating a group does not add its creator as a member, which is a common cause of a permissions error here.
| Input | Comments | Default |
|---|---|---|
| Connection | The Microsoft Planner connection to use. | |
| Group ID | The Microsoft 365 group that holds the plan. Only Microsoft 365 groups can contain Planner plans. | |
| Title | The title of the plan, shown wherever the plan is listed. |
Create Task
Create a task in a plan. Supplying a description performs a second write, because a task's description is stored on its details resource and cannot be set when the task is created.
| Input | Comments | Default |
|---|---|---|
| Connection | The Microsoft Planner connection to use. | |
| Group ID | The Microsoft 365 group whose plans populate the Plan ID dropdown. Only Microsoft 365 groups can hold Planner plans. Leave blank to list the plans shared with the connection's user instead. | |
| Plan ID | The unique identifier of the plan. | |
| Title | The title of the task, shown on its card in the Planner board. | |
| Bucket ID | The unique identifier of the bucket to create the task in. Leave blank to create the task without assigning it to a bucket. | |
| Assignment | Users to assign or unassign. | |
| Assign To | Users to assign to the task, identified by object ID. Existing assignees that are not listed here are left in place. | [] |
| Unassign | Users to remove from the task, identified by object ID. | [] |
| Schedule | Start and due timestamps. | |
| Start At | The timestamp the task starts, in ISO 8601 format. | |
| Due At | The timestamp the task is due, in ISO 8601 format. | |
| Priority | The priority of the task. Planner stores priority as a number from 0 to 10 and displays it in four bands, so these four values are the ones the Planner interface itself uses. | |
| Percent Complete | How complete the task is, from 0 to 100. Planner has no separate completed flag: setting this to 100 completes the task, and the service fills in who completed it and when. | |
| Categories | Colored categories to apply or remove. | |
| Apply | Colored categories to apply to the task. The label shown for each category is configured on the plan. | [] |
| Remove | Colored categories to remove from the task. | [] |
| Description | The description of the task. Descriptions live on the task's details resource rather than the task itself, so setting one is a separate write. |
Delete Bucket
Delete a bucket and the tasks it contains.
| Input | Comments | Default |
|---|---|---|
| Connection | The Microsoft Planner connection to use. | |
| Group ID | The Microsoft 365 group whose plans populate the Plan ID dropdown. Only Microsoft 365 groups can hold Planner plans. Leave blank to list the plans shared with the connection's user instead. | |
| Plan ID | The unique identifier of the plan. | |
| Bucket ID | The unique identifier of the bucket. | |
| ETag | The last known ETag of the resource being changed. Leave blank to let the action read the current ETag before writing. Supply a value to make the change conditional on that exact version, which fails with a conflict if the resource changed. |
Delete Plan
Delete a plan and everything it contains.
| Input | Comments | Default |
|---|---|---|
| Connection | The Microsoft Planner connection to use. | |
| Group ID | The Microsoft 365 group whose plans populate the Plan ID dropdown. Only Microsoft 365 groups can hold Planner plans. Leave blank to list the plans shared with the connection's user instead. | |
| Plan ID | The unique identifier of the plan. | |
| ETag | The last known ETag of the resource being changed. Leave blank to let the action read the current ETag before writing. Supply a value to make the change conditional on that exact version, which fails with a conflict if the resource changed. |
Delete Task
Delete a task.
| Input | Comments | Default |
|---|---|---|
| Connection | The Microsoft Planner connection to use. | |
| Group ID | The Microsoft 365 group whose plans populate the Plan ID dropdown. Only Microsoft 365 groups can hold Planner plans. Leave blank to list the plans shared with the connection's user instead. | |
| Plan ID | The unique identifier of the plan. | |
| Task ID | The unique identifier of the task. | |
| ETag | The last known ETag of the resource being changed. Leave blank to let the action read the current ETag before writing. Supply a value to make the change conditional on that exact version, which fails with a conflict if the resource changed. |
Get Bucket
Retrieve a single bucket by its ID.
| Input | Comments | Default |
|---|---|---|
| Connection | The Microsoft Planner connection to use. | |
| Group ID | The Microsoft 365 group whose plans populate the Plan ID dropdown. Only Microsoft 365 groups can hold Planner plans. Leave blank to list the plans shared with the connection's user instead. | |
| Plan ID | The unique identifier of the plan. | |
| Bucket ID | The unique identifier of the bucket. |
Get Plan
Retrieve a single plan by its ID.
| Input | Comments | Default |
|---|---|---|
| Connection | The Microsoft Planner connection to use. | |
| Group ID | The Microsoft 365 group whose plans populate the Plan ID dropdown. Only Microsoft 365 groups can hold Planner plans. Leave blank to list the plans shared with the connection's user instead. | |
| Plan ID | The unique identifier of the plan. |
Get Plan Details
Retrieve a plan's category labels and shared-with list.
| Input | Comments | Default |
|---|---|---|
| Connection | The Microsoft Planner connection to use. | |
| Group ID | The Microsoft 365 group whose plans populate the Plan ID dropdown. Only Microsoft 365 groups can hold Planner plans. Leave blank to list the plans shared with the connection's user instead. | |
| Plan ID | The unique identifier of the plan. |
Get Task
Retrieve a single task by its ID.
| Input | Comments | Default |
|---|---|---|
| Connection | The Microsoft Planner connection to use. | |
| Group ID | The Microsoft 365 group whose plans populate the Plan ID dropdown. Only Microsoft 365 groups can hold Planner plans. Leave blank to list the plans shared with the connection's user instead. | |
| Plan ID | The unique identifier of the plan. | |
| Task ID | The unique identifier of the task. |
Get Task Details
Retrieve a task's description, checklist, and links.
| Input | Comments | Default |
|---|---|---|
| Connection | The Microsoft Planner connection to use. | |
| Group ID | The Microsoft 365 group whose plans populate the Plan ID dropdown. Only Microsoft 365 groups can hold Planner plans. Leave blank to list the plans shared with the connection's user instead. | |
| Plan ID | The unique identifier of the plan. | |
| Task ID | The unique identifier of the task. |
List Buckets in Plan
List every bucket in a plan.
| Input | Comments | Default |
|---|---|---|
| Connection | The Microsoft Planner connection to use. | |
| Group ID | The Microsoft 365 group whose plans populate the Plan ID dropdown. Only Microsoft 365 groups can hold Planner plans. Leave blank to list the plans shared with the connection's user instead. | |
| Plan ID | The unique identifier of the plan. |
List Plans for User
List the plans shared with the user.
| Input | Comments | Default |
|---|---|---|
| Connection | The Microsoft Planner connection to use. |
List Plans in Group
List every plan contained by a Microsoft 365 group.
| Input | Comments | Default |
|---|---|---|
| Connection | The Microsoft Planner connection to use. | |
| Group ID | The Microsoft 365 group that holds the plan. Only Microsoft 365 groups can contain Planner plans. |
List Tasks for User
List every task assigned to the user, across every plan.
| Input | Comments | Default |
|---|---|---|
| Connection | The Microsoft Planner connection to use. |
List Tasks in Bucket
List every task in a single bucket.
| Input | Comments | Default |
|---|---|---|
| Connection | The Microsoft Planner connection to use. | |
| Group ID | The Microsoft 365 group whose plans populate the Plan ID dropdown. Only Microsoft 365 groups can hold Planner plans. Leave blank to list the plans shared with the connection's user instead. | |
| Plan ID | The unique identifier of the plan. | |
| Bucket ID | The unique identifier of the bucket. |
List Tasks in Plan
List every task in a plan, across all of its buckets.
| Input | Comments | Default |
|---|---|---|
| Connection | The Microsoft Planner connection to use. | |
| Group ID | The Microsoft 365 group whose plans populate the Plan ID dropdown. Only Microsoft 365 groups can hold Planner plans. Leave blank to list the plans shared with the connection's user instead. | |
| Plan ID | The unique identifier of the plan. |
Move Task to Bucket
Move a task into a different bucket. The destination bucket must belong to the same plan as the task.
| Input | Comments | Default |
|---|---|---|
| Connection | The Microsoft Planner connection to use. | |
| Group ID | The Microsoft 365 group whose plans populate the Plan ID dropdown. Only Microsoft 365 groups can hold Planner plans. Leave blank to list the plans shared with the connection's user instead. | |
| Plan ID | The unique identifier of the plan. | |
| Task ID | The unique identifier of the task. | |
| Bucket ID | The unique identifier of the bucket. | |
| ETag | The last known ETag of the resource being changed. Leave blank to let the action read the current ETag before writing. Supply a value to make the change conditional on that exact version, which fails with a conflict if the resource changed. |
Raw Request
Send a raw HTTP request to the Microsoft Graph API.
| Input | Comments | Default |
|---|---|---|
| Connection | The Microsoft Planner connection to use. | |
| URL | The path of the Microsoft Graph endpoint to call (e.g., /planner/plans). The base URL https://graph.microsoft.com/v1.0 is added automatically. Planner endpoints that modify or delete a resource require an If-Match header carrying the resource's current ETag. | |
| Method | The HTTP method to use. | |
| Data | The HTTP body payload to send to the URL. | |
| Form Data | The Form Data to be sent as a multipart form upload. | [] |
| File Data | File Data to be sent as a multipart form upload. | [] |
| File Data File Names | File names to apply to the file data inputs. Keys must match the file data keys above. | [] |
| Query Parameter | A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2. | [] |
| Header | A list of headers to send with the request. | [] |
| Response Type | The type of data you expect in the response. You can request json, text, or binary data. | json |
| Timeout | The maximum time that a client will await a response to its request | |
| Retry Delay (ms) | The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled. | 0 |
| Retry On All Errors | If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors. | false |
| Max Retry Count | The maximum number of retries to attempt. Specify 0 for no retries. | 0 |
| Use Exponential Backoff | Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored. | false |
Update Bucket
Rename a bucket. A bucket cannot be moved to a different plan.
| Input | Comments | Default |
|---|---|---|
| Connection | The Microsoft Planner connection to use. | |
| Group ID | The Microsoft 365 group whose plans populate the Plan ID dropdown. Only Microsoft 365 groups can hold Planner plans. Leave blank to list the plans shared with the connection's user instead. | |
| Plan ID | The unique identifier of the plan. | |
| Bucket ID | The unique identifier of the bucket. | |
| Name | The name of the bucket, shown as a column heading on the plan's board. | |
| ETag | The last known ETag of the resource being changed. Leave blank to let the action read the current ETag before writing. Supply a value to make the change conditional on that exact version, which fails with a conflict if the resource changed. |
Update Plan
Rename a plan. The title is the only property a plan allows changing.
| Input | Comments | Default |
|---|---|---|
| Connection | The Microsoft Planner connection to use. | |
| Group ID | The Microsoft 365 group whose plans populate the Plan ID dropdown. Only Microsoft 365 groups can hold Planner plans. Leave blank to list the plans shared with the connection's user instead. | |
| Plan ID | The unique identifier of the plan. | |
| Title | The title of the plan, shown wherever the plan is listed. | |
| ETag | The last known ETag of the resource being changed. Leave blank to let the action read the current ETag before writing. Supply a value to make the change conditional on that exact version, which fails with a conflict if the resource changed. |
Update Plan Details
Set a plan's category labels and adjust who it is shared with.
| Input | Comments | Default |
|---|---|---|
| Connection | The Microsoft Planner connection to use. | |
| Group ID | The Microsoft 365 group whose plans populate the Plan ID dropdown. Only Microsoft 365 groups can hold Planner plans. Leave blank to list the plans shared with the connection's user instead. | |
| Plan ID | The unique identifier of the plan. | |
| Category Labels | Labels for the plan's colored categories, keyed by category1 through category25. Only the categories listed here change; leave a category out to keep its current label. | [] |
| Sharing | Users to add to or remove from the shared-with list. | |
| Share With | Users to add to the plan's shared-with list, identified by object ID. For a plan contained by a Microsoft 365 group, managing group membership is usually preferable to sharing individually. | [] |
| Unshare With | Users to remove from the plan's shared-with list, identified by object ID. | [] |
| Plan Details ETag | The last known ETag of the plan details. Plan details carry their own ETag, separate from the plan's, so a plan ETag cannot be used here. Leave blank to read the current value before writing. |
Update Task
Update a task's properties. Only the fields supplied are changed; everything else keeps its current value.
| Input | Comments | Default |
|---|---|---|
| Connection | The Microsoft Planner connection to use. | |
| Group ID | The Microsoft 365 group whose plans populate the Plan ID dropdown. Only Microsoft 365 groups can hold Planner plans. Leave blank to list the plans shared with the connection's user instead. | |
| Plan ID | The unique identifier of the plan. | |
| Task ID | The unique identifier of the task. | |
| Title | A new title for the task. Leave blank to keep the current title. | |
| Bucket ID | The unique identifier of the bucket. Leave blank to leave the task in its current bucket. | |
| Assignment | Users to assign or unassign. | |
| Assign To | Users to assign to the task, identified by object ID. Existing assignees that are not listed here are left in place. | [] |
| Unassign | Users to remove from the task, identified by object ID. | [] |
| Schedule | Start and due timestamps. | |
| Start At | The timestamp the task starts, in ISO 8601 format. | |
| Due At | The timestamp the task is due, in ISO 8601 format. | |
| Priority | The priority of the task. Planner stores priority as a number from 0 to 10 and displays it in four bands, so these four values are the ones the Planner interface itself uses. | |
| Percent Complete | How complete the task is, from 0 to 100. Planner has no separate completed flag: setting this to 100 completes the task, and the service fills in who completed it and when. | |
| Categories | Colored categories to apply or remove. | |
| Apply | Colored categories to apply to the task. The label shown for each category is configured on the plan. | [] |
| Remove | Colored categories to remove from the task. | [] |
| Conversation Thread ID | The identifier of the group conversation thread associated with the task. | |
| ETag | The last known ETag of the resource being changed. Leave blank to let the action read the current ETag before writing. Supply a value to make the change conditional on that exact version, which fails with a conflict if the resource changed. |
Update Task Details
Set a task's description, checklist items, and external links.
| Input | Comments | Default |
|---|---|---|
| Connection | The Microsoft Planner connection to use. | |
| Group ID | The Microsoft 365 group whose plans populate the Plan ID dropdown. Only Microsoft 365 groups can hold Planner plans. Leave blank to list the plans shared with the connection's user instead. | |
| Plan ID | The unique identifier of the plan. | |
| Task ID | The unique identifier of the task. | |
| Description | The description of the task. Descriptions live on the task's details resource rather than the task itself, so setting one is a separate write. | |
| Checklist | Checklist items to add or remove. | |
| Add Items | Checklist items to add, where the key is the item title and the value is true if the item starts checked. | [] |
| Remove Items | Identifiers of checklist items to remove. Use the Get Task Details action to read the current item identifiers. | [] |
| Links | External links to attach or remove. | |
| Add | External links to attach to the task, where the key is the URL and the value is the display name shown in Planner. | [] |
| Remove | URLs of external links to remove from the task. | [] |
| Preview Type | Which part of the task details is shown on the task's card in the Planner board. | |
| Task Details ETag | The last known ETag of the task details. Task details carry their own ETag, separate from the task's, so a task ETag cannot be used here. Leave blank to read the current value before writing. |