Update Task with Microsoft 365 Planner API on New Labeled Email from Gmail API

Pipedream makes it easy to connect APIs for Microsoft 365 Planner, Gmail and 2,500+ other apps remarkably fast.

Trigger workflow on

New Labeled Email from the Gmail API

Next, do this

Update Task with the Microsoft 365 Planner API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Gmail trigger and Microsoft 365 Planner action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Labeled Email trigger
1. Connect your Gmail account
2. Configure timer
3. Select one or more Labels
Configure the Update Task action
1. Connect your Microsoft 365 Planner account
2. Select a User Task ID
3. Optional- Configure Title
4. Optional- Configure Priority
5. Optional- Configure Percent Complete
6. Optional- Configure Due Date Time
7. Optional- Configure Start Date Time
8. Optional- Configure Order Hint
9. Optional- Configure Assignee Priority
10. Optional- Select a Group
11. Optional- Select a Conversation Thread ID
12. Optional- Select one or more Assignees
13. Optional- Select a Plan
14. Optional- Select a Bucket
15. Optional- Select one or more Applied Categories
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger#

New Labeled Email on Gmail

Description:Emit new event when a new email is labeled.

Version:0.0.10

Key:gmail-new-labeled-email

View on GitHub

Gmail Overview#

By connecting your personal Gmail account to Pipedream, you'll be able to incorporate email into whatever you're building with any of the thousands of apps that are available on Pipedream.

Trigger Code#

import gmail from "../../gmail.app.mjs";
import common from "../common/polling-history.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...common,
  key: "gmail-new-labeled-email",
  name: "New Labeled Email",
  description: "Emit new event when a new email is labeled.",
  type: "source",
  version: "0.0.10",
  dedupe: "unique",
  props: {
    gmail,
    ...common.props,
    labels: {
      propDefinition: [
        gmail,
        "label",
      ],
      type: "string[]",
      label: "Labels",
    },
  },
  methods: {
    ...common.methods,
    getHistoryTypes() {
      return [
        "labelAdded",
        "messageAdded",
      ];
    },
    generateMeta(message) {
      return {
        id: `${message.id}-${message.historyId}`,
        summary: `A new message with ID: ${message.id} was labeled"`,
        ts: +message.internalDate,
      };
    },
    filterHistory(history) {
      return history.filter((item) =>
        (item.labelsAdded && item.labelsAdded[0].labelIds.some((i) => this.labels.includes(i)))
        || (item.messagesAdded
          && item.messagesAdded[0].message.labelIds
          && item.messagesAdded[0].message.labelIds.some((i) => this.labels.includes(i))));
    },
  },
  sampleEmit,
};

Trigger Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Gmail	`gmail`	`app`	This component uses the Gmail app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Labels	`labels`	`string[]`	Select a value from the drop down menu.

Trigger Authentication#

Gmail uses OAuth authentication. When you connect your Gmail account, Pipedream will open a popup window where you can sign into Gmail and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Gmail API.

Pipedream requests the following authorization scopes when you connect your account:

emailprofileopenidhttps://www.googleapis.com/auth/gmail.labelshttps://www.googleapis.com/auth/gmail.sendhttps://www.googleapis.com/auth/gmail.modifyhttps://www.googleapis.com/auth/gmail.composehttps://www.googleapis.com/auth/gmail.settings.basic

About Gmail#

Gmail offers private and secure email by Google at no cost, for business and consumer accounts.

Action#

Update Task on Microsoft 365 Planner

Description:Updates a task in Microsoft 365 Planner. [See the documentation](https://learn.microsoft.com/en-us/graph/api/plannertask-update?view=graph-rest-1.0&tabs=http)

Version:0.0.1

Key:microsoft_365_planner-update-task

View on GitHub

Microsoft 365 Planner Overview#

The Microsoft 365 Planner API lets you tap into the robust task management capabilities of Planner within the Microsoft 365 suite. With this API on Pipedream, you can automate tasks, sync Planner data with other services, manage plans, tasks, and buckets programmatically. This opens up possibilities for creating custom workflows to enhance productivity, streamline project tracking, and maintain synchronization across various platforms.

Action Code#

import app from "../../microsoft_365_planner.app.mjs";
import utils from "../../common/utils.mjs";

export default {
  key: "microsoft_365_planner-update-task",
  name: "Update Task",
  description: "Updates a task in Microsoft 365 Planner. [See the documentation](https://learn.microsoft.com/en-us/graph/api/plannertask-update?view=graph-rest-1.0&tabs=http)",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    taskId: {
      propDefinition: [
        app,
        "userTaskId",
      ],
    },
    title: {
      type: "string",
      label: "Title",
      description: "Title of the task",
      optional: true,
    },
    priority: {
      type: "integer",
      label: "Priority",
      description: "Priority of the task. The valid range of values is between `0` and `10`, with the increasing value being lower priority (`0` has the highest priority and `10` has the lowest priority)",
      optional: true,
      min: 0,
      max: 10,
    },
    percentComplete: {
      type: "integer",
      label: "Percent Complete",
      description: "Percentage of task completion. When set to `100`, the task is considered completed.",
      optional: true,
    },
    dueDateTime: {
      type: "string",
      label: "Due Date Time",
      description: "Date and time at which the task is due. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.",
      optional: true,
    },
    startDateTime: {
      type: "string",
      label: "Start Date Time",
      description: "Date and time at which the task starts. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.",
      optional: true,
    },
    orderHint: {
      type: "string",
      label: "Order Hint",
      description: "Hint used to order items of this type in a list view. The format is defined in [Using order hints in Planner](https://learn.microsoft.com/en-us/graph/api/resources/planner-order-hint-format?view=graph-rest-1.0).",
      optional: true,
    },
    assigneePriority: {
      type: "string",
      label: "Assignee Priority",
      description: "Hint used to order items of this type in a list view. The format is defined as outlined [here](https://learn.microsoft.com/en-us/graph/api/resources/planner-order-hint-format?view=graph-rest-1.0).",
      optional: true,
    },
    groupId: {
      optional: true,
      propDefinition: [
        app,
        "groupId",
      ],
    },
    conversationThreadId: {
      propDefinition: [
        app,
        "conversationThreadId",
        ({ groupId }) => ({
          groupId,
        }),
      ],
    },
    assignmentIds: {
      propDefinition: [
        app,
        "assigneeIds",
        ({ groupId }) => ({
          groupId,
        }),
      ],
    },
    planId: {
      optional: true,
      propDefinition: [
        app,
        "planId",
        ({ groupId }) => ({
          groupId,
        }),
      ],
    },
    bucketId: {
      propDefinition: [
        app,
        "bucketId",
        ({ planId }) => ({
          planId,
        }),
      ],
    },
    appliedCategories: {
      type: "string[]",
      label: "Applied Categories",
      description: "The categories to which the task has been applied. See [applied Categories](https://learn.microsoft.com/en-us/graph/api/resources/plannerappliedcategories?view=graph-rest-1.0) for possible values.",
      optional: true,
      options: Array.from({
        length: 6,
      }, (_, idx) => `category${idx + 1}`),
    },
  },
  methods: {
    getAppliedCategories(appliedCategories = []) {
      return utils.parseArray(appliedCategories)?.reduce((acc, category) => ({
        ...acc,
        [category]: true,
      }), {});
    },
    getAssignments(assignmentIds = []) {
      return utils.parseArray(assignmentIds)?.reduce((acc, id) => ({
        ...acc,
        [id]: {
          "@odata.type": "microsoft.graph.plannerAssignment",
          "orderHint": " !",
        },
      }), {});
    },
    updateTask({
      taskId, ...args
    } = {}) {
      return this.app._makeRequest({
        method: "PATCH",
        path: `/planner/tasks/${taskId}`,
        ...args,
      });
    },
  },
  async run({ $ }) {
    const {
      app,
      getAssignments,
      getAppliedCategories,
      updateTask,
      taskId,
      title,
      priority,
      percentComplete,
      startDateTime,
      dueDateTime,
      assigneePriority,
      conversationThreadId,
      assignmentIds,
      bucketId,
      appliedCategories,
    } = this;

    const { ["@odata.etag"]: etag } = await app.getTask({
      $,
      taskId,
    });

    const response = await updateTask({
      $,
      taskId,
      headers: {
        "Content-Type": "application/json",
        "If-Match": etag,
        "Prefer": "return=representation",
      },
      data: {
        title,
        priority,
        percentComplete,
        startDateTime,
        dueDateTime,
        assigneePriority,
        conversationThreadId,
        bucketId,
        assignments: getAssignments(assignmentIds),
        appliedCategories: getAppliedCategories(appliedCategories),
      },
    });

    $.export("$summary", `Successfully updated task with ID \`${response.id}\`.`);

    return response;
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
Microsoft 365 Planner	`app`	`app`	This component uses the Microsoft 365 Planner app.
User Task ID	`taskId`	`string`	Select a value from the drop down menu.
Title	`title`	`string`	Title of the task
Priority	`priority`	`integer`	Priority of the task. The valid range of values is between `0` and `10`, with the increasing value being lower priority (`0` has the highest priority and `10` has the lowest priority)
Percent Complete	`percentComplete`	`integer`	Percentage of task completion. When set to `100`, the task is considered completed.
Due Date Time	`dueDateTime`	`string`	Date and time at which the task is due. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.
Start Date Time	`startDateTime`	`string`	Date and time at which the task starts. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.
Order Hint	`orderHint`	`string`	Hint used to order items of this type in a list view. The format is defined in Using order hints in Planner
Assignee Priority	`assigneePriority`	`string`	Hint used to order items of this type in a list view. The format is defined as outlined here
Group	`groupId`	`string`	Select a value from the drop down menu.
Conversation Thread ID	`conversationThreadId`	`string`	Select a value from the drop down menu.
Assignees	`assignmentIds`	`string[]`	Select a value from the drop down menu.
Plan	`planId`	`string`	Select a value from the drop down menu.
Bucket	`bucketId`	`string`	Select a value from the drop down menu.
Applied Categories	`appliedCategories`	`string[]`	Select a value from the drop down menu:`category1category2category3category4category5category6`

Action Authentication#

Microsoft 365 Planner uses OAuth authentication. When you connect your Microsoft 365 Planner account, Pipedream will open a popup window where you can sign into Microsoft 365 Planner and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Microsoft 365 Planner API.

Pipedream requests the following authorization scopes when you connect your account:

emailoffline_accessopenidprofileGroup.ReadWrite.AllFiles.ReadWriteFiles.Read.AllMailboxSettings.ReadTasks.ReadWriteUser.ReadUser.Read.All

About Microsoft 365 Planner#

A simple, visual way to organize teamwork.

More Ways to Connect Microsoft 365 Planner + Gmail#

Other Popular Integrations#

Create Bucket with Microsoft 365 Planner API on New Labeled Email from Gmail API

Gmail + Microsoft 365 Planner

Update Task with Microsoft 365 Planner API on New Labeled Email from Gmail API

Pipedream makes it easy to connect APIs for Microsoft 365 Planner, Gmail and 2,500+ other apps remarkably fast.

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

1-24of2,500+apps by most popular

1
-
24
of
2,500+
apps by most popular