Download File with Sharepoint API on New Ticket from Freshservice API

Pipedream makes it easy to connect APIs for Sharepoint, Freshservice and 3,000+ other apps remarkably fast.

Trigger workflow on

New Ticket from the Freshservice API

Next, do this

Download File with the 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#

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

Select this integration
Configure the New Ticket trigger
1. Connect your Freshservice account
2. Configure timer
Configure the Download File action
1. Connect your Sharepoint account
2. Select a Site
3. Select a Drive ID
4. Select a File ID
5. Configure Filename
6. Optional- Select a Convert To Format
7. Configure syncDir
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 Ticket on Freshservice

Description:Emit new event for each created ticket. [See documentation](https://api.freshservice.com/#view_all_ticket)

Version:0.0.3

Key:freshservice-new-ticket

View on GitHub

Freshservice Overview#

The Freshservice API opens up a realm of possibilities for streamlining IT service management processes. It allows you to interact programmatically with Freshservice features, such as creating tickets, managing users, updating service catalog items, and more. Leveraging the Freshservice API on Pipedream, you can automate repetitive tasks, create complex workflows that react to events in Freshservice in real time, and connect Freshservice to a multitude of other services to enhance its capabilities and your productivity.

Trigger Code#

import common from "../common/base.mjs";

export default {
  ...common,
  name: "New Ticket",
  version: "0.0.3",
  key: "freshservice-new-ticket",
  description: "Emit new event for each created ticket. [See documentation](https://api.freshservice.com/#view_all_ticket)",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getResourceFn() {
      return this.freshservice.listTickets;
    },
    getParams() {
      return {
        order_type: "desc",
      };
    },
    getResourceKey() {
      return "tickets";
    },
    generateMeta(ticket) {
      return {
        id: ticket.id,
        summary: `New ticket with ID ${ticket.id}`,
        ts: Date.parse(ticket.created_at),
      };
    },
  },
};

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
Freshservice	`freshservice`	`app`	This component uses the Freshservice app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`

Trigger Authentication#

Freshservice uses API keys for authentication. When you connect your Freshservice account, Pipedream securely stores the keys so you can easily authenticate to Freshservice APIs in both code and no-code steps.

Your Freshservice API key is in your Profile > Settings page, below the change password section on the right.

Your domain is displayed in your Freshdesk URL. For example, https://{your_domain_here}.freshservice.com/.

About Freshservice#

Cloud-based IT Service Management solution

Action#

Download File on Sharepoint

Description:Download a Microsoft Sharepoint file to the /tmp directory. [See the documentation](https://learn.microsoft.com/en-us/graph/api/driveitem-get-content?view=graph-rest-1.0&tabs=http)

Version:0.0.11

Key:sharepoint-download-file

View on GitHub

Sharepoint Overview#

The Microsoft SharePoint Online API opens up a world of possibilities for integrating your SharePoint content with other services and automating tasks. With Pipedream, you can harness this API to create powerful workflows that trigger on events in SharePoint, manipulate data, and connect with countless other apps. Create custom automations for document management, team notifications, content moderation, and more, without the need to manage infrastructure.

Action Code#

import sharepoint from "../../sharepoint.app.mjs";
import fs from "fs";
import path from "path";
import { ConfigurationError } from "@pipedream/platform";
import constants from "../../common/constants.mjs";

export default {
  key: "sharepoint-download-file",
  name: "Download File",
  description: "Download a Microsoft Sharepoint file to the /tmp directory. [See the documentation](https://learn.microsoft.com/en-us/graph/api/driveitem-get-content?view=graph-rest-1.0&tabs=http)",
  version: "0.0.11",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: true,
  },
  type: "action",
  props: {
    sharepoint,
    siteId: {
      propDefinition: [
        sharepoint,
        "siteId",
      ],
    },
    driveId: {
      propDefinition: [
        sharepoint,
        "driveId",
        (c) => ({
          siteId: c.siteId,
        }),
      ],
    },
    fileId: {
      propDefinition: [
        sharepoint,
        "fileId",
        (c) => ({
          siteId: c.siteId,
          driveId: c.driveId,
        }),
      ],
    },
    filename: {
      type: "string",
      label: "Filename",
      description: "The filename to save the downloaded file as in the `/tmp` directory",
    },
    convertToFormat: {
      type: "string",
      label: "Convert To Format",
      description: "The format to convert the file to. See the [Format Options](https://learn.microsoft.com/en-us/graph/api/driveitem-get-content-format?view=graph-rest-1.0&tabs=http#format-options) for supported source formats",
      options: [
        "pdf",
        "html",
      ],
      optional: true,
    },
    syncDir: {
      type: "dir",
      accessMode: "write",
      sync: true,
    },
  },
  methods: {
    async getOriginalFileData($) {
      const { name: originalFilename } = await this.sharepoint.getDriveItem({
        $,
        driveId: this.driveId,
        siteId: this.siteId,
        fileId: this.fileId,
      });
      const originalExtension = path.extname(originalFilename).slice(1)
        .toLowerCase() || undefined;
      return {
        originalFilename,
        originalExtension,
      };
    },
    formatNewFilename(originalExtension) {
      const parsed = path.parse(this.filename);
      if (this.convertToFormat) {
        const base = parsed.ext
          ? parsed.name
          : this.filename;
        return `${base}.${this.convertToFormat.toLowerCase()}`;
      }
      if (parsed.ext) {
        return this.filename;
      }
      return originalExtension
        ? `${this.filename}.${originalExtension}`
        : this.filename;
    },
    validateConversionFormat(originalExtension) {
      const supportedFormats = this.convertToFormat === "pdf"
        ? constants.PDF_CONVERTIBLE_FORMATS
        : this.convertToFormat === "html"
          ? constants.HTML_CONVERTIBLE_FORMATS
          : [];
      if (!supportedFormats.includes(originalExtension)) {
        throw new ConfigurationError(`The file extension "${originalExtension}" is not supported for conversion to "${this.convertToFormat}". Supported formats are: ${supportedFormats.join(", ")}`);
      }
    },
  },
  async run({ $ }) {
    const {
      originalFilename, originalExtension,
    } = await this.getOriginalFileData($);

    // ensure filename has an extension
    const filename = this.formatNewFilename(originalExtension);

    if (this.convertToFormat) {
      this.validateConversionFormat(originalExtension);
    }

    let response;
    let args = {
      $,
      driveId: this.driveId,
      fileId: this.fileId,
      params: {
        format: this.convertToFormat,
      },
    };
    try {
      response = await this.sharepoint.getFile({
        ...args,
        responseType: "arraybuffer",
      });
    } catch {
      // throw error without buffer encoding
      await this.sharepoint.getFile(args);
    }

    const rawcontent = response.toString("base64");
    const buffer = Buffer.from(rawcontent, "base64");
    // Since the filepath is not returned as one of the standard keys (filePath
    // or path), save the file to STASH_DIR, if defined, so it is synced at the
    // end of execution.
    const downloadedFilepath = `${process.env.STASH_DIR || "/tmp"}/${filename}`;
    fs.writeFileSync(downloadedFilepath, buffer);

    const data = {
      filename,
      fileSize: `${buffer.length} bytes`,
      extension: this.convertToFormat || originalExtension,
      downloadedFilepath,
    };

    if (this.convertToFormat) {
      data.originalFilename = originalFilename;
      data.originalExtension = originalExtension;
    }

    return data;
  },
};

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
Sharepoint	`sharepoint`	`app`	This component uses the 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.
File ID	`fileId`	`string`	Select a value from the drop down menu.
Filename	`filename`	`string`	The filename to save the downloaded file as in the `/tmp` directory
Convert To Format	`convertToFormat`	`string`	Select a value from the drop down menu:`pdfhtml`
syncDir	`syncDir`	`dir`

Action Authentication#

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

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

offline_accessemailopenidSites.Manage.AllSites.Read.AllSites.ReadWrite.AllUser.Read.AllGroup.Read.AllSites.FullControl.All

Download File with Sharepoint API on New Ticket from Freshservice API

Pipedream makes it easy to connect APIs for Sharepoint, Freshservice and 3,000+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of3,000+apps by most popular

1
-
24
of
3,000+
apps by most popular