ByteChef LogoByteChef

Microsoft To Do

Microsoft To Do is a cloud-based task management application that helps users organize, prioritize, and track tasks across devices with features like lists, reminders, and collaboration.

Categories: Productivity and Collaboration

Type: microsoftToDo/v1


Connections

Version: 1

OAuth2 Authorization Code

Properties

NameLabelTypeDescriptionRequired
clientIdClient IdSTRINGtrue
clientSecretClient SecretSTRINGtrue
tenantIdTenant IdSTRINGtrue

Connection Setup

Create OAuth 2.0 Application

Creation of OAuth 2.0 application is documented here.

Grant Necessary Permissions

  1. Open the Azure Portal: https://portal.azure.com/
  2. Click on App registrations.
  3. Click on All applications.
  4. Click on application you want to connect to Microsoft To Do.
  5. Click on API permissions.
  6. Click on Microsoft Graph (1).
  7. Select following scopes:
    • Tasks.ReadWrite
    • offline_access
  8. After selecting all the scopes click on Update permissions

Actions

Create Task

Name: createTask

Creates a new task.

Properties

NameLabelTypeDescriptionRequired
taskListIdTask List IDSTRINGID of the task list where the task will be created.true
titleTitleSTRINGTitle of the task.true
importanceImportanceSTRING
Options low, normal, high
Importance of the task.false
isReminderOnReminderBOOLEAN
Options true, false
Set to true if an alert is set to remind the user of the task.false

Example JSON Structure

{
  "label" : "Create Task",
  "name" : "createTask",
  "parameters" : {
    "taskListId" : "",
    "title" : "",
    "importance" : "",
    "isReminderOn" : false
  },
  "type" : "microsoftToDo/v1/createTask"
}

Output

Type: OBJECT

Properties

NameTypeDescription
@odata.etagSTRING
importanceSTRINGImportance of the task.
isReminderOnBOOLEAN
Options true, false
Indicates whether an alert is set to reminder the user of the task.
statusSTRINGState or progress of the task.
titleSTRINGTitle of the task.
categoriesSTRINGThe categories associated with the task.
idSTRINGID of the task.
bodyOBJECT
Properties {STRING(content), STRING(contentType)}
Body of the task containing information about the task.
linkedResourcesOBJECT
Properties {STRING(id), STRING(webUrl), STRING(applicationName), STRING(displayName)}

Output Example

{
  "@odata.etag" : "",
  "importance" : "",
  "isReminderOn" : false,
  "status" : "",
  "title" : "",
  "categories" : "",
  "id" : "",
  "body" : {
    "content" : "",
    "contentType" : ""
  },
  "linkedResources" : {
    "id" : "",
    "webUrl" : "",
    "applicationName" : "",
    "displayName" : ""
  }
}

Create Task List

Name: createTaskList

Creates a new task list.

Properties

NameLabelTypeDescriptionRequired
displayNameTitleSTRINGTitle of the task list.true

Example JSON Structure

{
  "label" : "Create Task List",
  "name" : "createTaskList",
  "parameters" : {
    "displayName" : ""
  },
  "type" : "microsoftToDo/v1/createTaskList"
}

Output

Type: OBJECT

Properties

NameTypeDescription
@odata.contextSTRING
@odata.etagSTRING
idSTRINGID of the task list.
displayNameSTRINGThe name of the task list.
isOwnerBOOLEAN
Options true, false
Indicates whether the user is the owner of the task list.
isSharedBOOLEAN
Options true, false
Indicates whether the task list is shared with other users.
wellKnownListNameSTRINGProperty indicating the list name if the given list is a well-known list. The possible values are: none, defaultList, flaggedEmails, unknownFutureValue.

Output Example

{
  "@odata.context" : "",
  "@odata.etag" : "",
  "id" : "",
  "displayName" : "",
  "isOwner" : false,
  "isShared" : false,
  "wellKnownListName" : ""
}

Delete Task

Name: deleteTask

Deletes a task by ID.

Properties

NameLabelTypeDescriptionRequired
taskListIdTask List IDSTRINGID of the task list where the task is located.true
taskIdTask IDSTRING
Depends On taskListId
ID of the task to delete.true

Example JSON Structure

{
  "label" : "Delete Task",
  "name" : "deleteTask",
  "parameters" : {
    "taskListId" : "",
    "taskId" : ""
  },
  "type" : "microsoftToDo/v1/deleteTask"
}

Output

This action does not produce any output.

Get Task

Name: getTask

Gets task by ID.

Properties

NameLabelTypeDescriptionRequired
taskListIdTask List IDSTRINGID of the task list where the task is located.true
taskIdTask IDSTRING
Depends On taskListId
ID of the task to retrieve.true

Example JSON Structure

{
  "label" : "Get Task",
  "name" : "getTask",
  "parameters" : {
    "taskListId" : "",
    "taskId" : ""
  },
  "type" : "microsoftToDo/v1/getTask"
}

Output

Type: OBJECT

Properties

NameTypeDescription
@odata.etagSTRING
importanceSTRINGImportance of the task.
isReminderOnBOOLEAN
Options true, false
Indicates whether an alert is set to reminder the user of the task.
statusSTRINGState or progress of the task.
titleSTRINGTitle of the task.
categoriesSTRINGThe categories associated with the task.
idSTRINGID of the task.
bodyOBJECT
Properties {STRING(content), STRING(contentType)}
Body of the task containing information about the task.
linkedResourcesOBJECT
Properties {STRING(id), STRING(webUrl), STRING(applicationName), STRING(displayName)}

Output Example

{
  "@odata.etag" : "",
  "importance" : "",
  "isReminderOn" : false,
  "status" : "",
  "title" : "",
  "categories" : "",
  "id" : "",
  "body" : {
    "content" : "",
    "contentType" : ""
  },
  "linkedResources" : {
    "id" : "",
    "webUrl" : "",
    "applicationName" : "",
    "displayName" : ""
  }
}

Triggers

New Task

Name: newTask

Triggers when a new task is created in a specified task list.

Type: POLLING

Properties

NameLabelTypeDescriptionRequired
taskListIdTask List IDSTRINGID of the task list to monitor for new tasks.true

Output

Type: OBJECT

Properties

NameTypeDescription
@odata.etagSTRING
importanceSTRINGImportance of the task.
isReminderOnBOOLEAN
Options true, false
Indicates whether an alert is set to reminder the user of the task.
statusSTRINGState or progress of the task.
titleSTRINGTitle of the task.
categoriesSTRINGThe categories associated with the task.
idSTRINGID of the task.
bodyOBJECT
Properties {STRING(content), STRING(contentType)}
Body of the task containing information about the task.
linkedResourcesOBJECT
Properties {STRING(id), STRING(webUrl), STRING(applicationName), STRING(displayName)}

JSON Example

{
  "label" : "New Task",
  "name" : "newTask",
  "parameters" : {
    "taskListId" : ""
  },
  "type" : "microsoftToDo/v1/newTask"
}

What to do if your action is not listed here?

If this component doesn't have the action you need, you can use Custom Action to create your own. Custom Actions empower you to define HTTP requests tailored to your specific requirements, allowing for greater flexibility in integrating with external services or APIs.

To create a Custom Action, simply specify the desired HTTP method, path, and any necessary parameters. This way, you can extend the functionality of your component beyond the predefined actions, ensuring that you can meet all your integration needs effectively.

How is this guide?

Last updated on

On this page