Upload File with Microsoft Sharepoint API

Pipedream makes it easy to connect APIs for Microsoft Sharepoint and 2,900+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Upload File with the Microsoft Sharepoint 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#

Create a workflow to Upload File with the Microsoft Sharepoint API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Upload File action
1. Connect your Microsoft Sharepoint account
2. Select a Site
3. Select a Drive ID
4. Optional- Select a Upload Folder ID
5. Configure File Path or URL
6. Configure Name
7. Optional- Configure syncDir
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Upload File with Microsoft Sharepoint Online API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Microsoft Sharepoint

Try it

Upload File with Microsoft Sharepoint Online API on New Submission from Typeform API

Typeform + Microsoft Sharepoint

Try it

Upload File with Microsoft Sharepoint Online API on New Submission (Instant) from Jotform API

Jotform + Microsoft Sharepoint

Try it

Upload File with Microsoft Sharepoint Online API on New Scheduled Tasks from Pipedream API

Pipedream + Microsoft Sharepoint

Try it

Upload File with Microsoft Sharepoint Online API on New Download Counts from npm API

npm + Microsoft Sharepoint

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is 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.

Upload File on Microsoft Sharepoint

Description:Upload a file to OneDrive. [See the documentation](https://learn.microsoft.com/en-us/onedrive/developer/rest-api/api/driveitem_put_content?view=odsp-graph-online)

Version:0.0.1

Key:sharepoint-upload-file

View on GitHub

Code#

import sharepoint from "../../sharepoint.app.mjs";
import { getFileStreamAndMetadata } from "@pipedream/platform";

export default {
  key: "sharepoint-upload-file",
  name: "Upload File",
  description: "Upload a file to OneDrive. [See the documentation](https://learn.microsoft.com/en-us/onedrive/developer/rest-api/api/driveitem_put_content?view=odsp-graph-online)",
  version: "0.0.1",
  type: "action",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  props: {
    sharepoint,
    siteId: {
      propDefinition: [
        sharepoint,
        "siteId",
      ],
    },
    driveId: {
      propDefinition: [
        sharepoint,
        "driveId",
        (c) => ({
          siteId: c.siteId,
        }),
      ],
    },
    uploadFolderId: {
      propDefinition: [
        sharepoint,
        "folderId",
        (c) => ({
          siteId: c.siteId,
          driveId: c.driveId,
        }),
      ],
      label: "Upload Folder ID",
      description: "The ID of the folder where you want to upload the file. You can either search for the folder here or provide a custom *Folder ID*.",
    },
    filePath: {
      type: "string",
      label: "File Path or URL",
      description: "The file to upload. Provide either a file URL or a path to a file in the `/tmp` directory (for example, `/tmp/myFile.txt`)",
    },
    filename: {
      type: "string",
      label: "Name",
      description: "Name of the new uploaded file",
    },
    syncDir: {
      type: "dir",
      accessMode: "read",
      sync: true,
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      siteId, driveId, uploadFolderId, filePath, filename,
    } = this;

    const {
      stream, metadata,
    } = await getFileStreamAndMetadata(filePath);
    const name = filename || metadata.name;

    const response = await this.sharepoint.uploadFile({
      siteId,
      driveId,
      uploadFolderId,
      name,
      data: stream,
      $,
    });

    if (response?.id) {
      $.export("$summary", `Successfully uploaded file with ID ${response.id}.`);
    }

    return response;
  },
};

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
Microsoft Sharepoint	`sharepoint`	`app`	This component uses the Microsoft Sharepoint app.
Site	`siteId`	`string`	Select a value from the drop down menu.
Drive ID	`driveId`	`string`	Select a value from the drop down menu.
Upload Folder ID	`uploadFolderId`	`string`	Select a value from the drop down menu.
File Path or URL	`filePath`	`string`	The file to upload. Provide either a file URL or a path to a file in the `/tmp` directory (for example, `/tmp/myFile.txt`)
Name	`filename`	`string`	Name of the new uploaded file
N/A	`syncDir`	`dir`	This component uses `dir` to share files between component executions.

Authentication#

Microsoft Sharepoint uses OAuth authentication. When you connect your Microsoft Sharepoint account, Pipedream will open a popup window where you can sign into Microsoft Sharepoint 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 Sharepoint API.

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

emailoffline_accessopenidprofileSites.Manage.AllSites.Read.AllSites.ReadWrite.AllUser.Read