Download File with Microsoft OneDrive API on New Event from ChatBot API

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

Trigger workflow on

New Event from the ChatBot API

Next, do this

Download File with the Microsoft OneDrive 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 ChatBot trigger and Microsoft OneDrive action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Event trigger
1. Connect your ChatBot account
2. Optional- Configure Webhook Name
Configure the Download File action
1. Connect your Microsoft OneDrive account
2. Optional- Select a File ID
3. Optional- Configure File Path
4. Configure New File Name
5. 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 Event on ChatBot

Description:Emit new event for event received. *Need to be configured in the ChatBot UI flow to emit events*. [See docs here](https://www.chatbot.com/docs/webhooks/)

Version:0.0.1

Key:chatbot-new-event

View on GitHub

ChatBot Overview#

Leverage the ChatBot API on Pipedream to automate conversations, streamline customer service, and connect chat functionality with various apps for rich, responsive interaction. With this API, you can programmatically send messages, manage chat histories, and implement chatbots that react to user input in real-time. By integrating with Pipedream, these capabilities can be augmented with thousands of apps, enabling seamless data flow and complex automations.

Trigger Code#

import chatbot from "../../chatbot.app.mjs";
import { v4 as uuid } from "uuid";

export default {
  key: "chatbot-new-event",
  name: "New Event",
  description: "Emit new event for event received. *Need to be configured in the ChatBot UI flow to emit events*. [See docs here](https://www.chatbot.com/docs/webhooks/)",
  version: "0.0.1",
  type: "source",
  props: {
    chatbot,
    db: "$.service.db",
    http: {
      type: "$.interface.http",
      customResponse: true,
    },
    name: {
      label: "Webhook Name",
      description: "The name of the webhook, this will be used to select in the ChatBot UI flow",
      type: "string",
      optional: true,
    },
  },
  methods: {
    async _respondWebHook(http, event) {
      http.respond({
        status: 200,
        body: event.query.challenge,
      });
    },
    _getWebhookId() {
      return this.db.get("webhookId");
    },
    _setWebhookId(webhookId) {
      this.db.set("webhookId", webhookId);
    },
  },
  hooks: {
    async activate() {
      const validationToken = uuid();

      const response = await this.chatbot.createWebhook({
        auth: {},
        headers: [],
        name: this.name ?? `Webhook ${validationToken}`,
        token: validationToken,
        url: this.http.endpoint,
      });

      this._setWebhookId(response.id);
    },
    async deactivate() {
      const webhookId = this._getWebhookId();
      await this.chatbot.deleteWebhook(webhookId);
    },
  },
  async run(event) {
    await this._respondWebHook(this.http, event);

    const {
      body,
      headers,
    } = event;

    this.$emit(body, {
      id: headers["x-request-id"],
      summary: `New event ${headers["x-request-id"]} received`,
      ts: new Date(),
    });
  },
};

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
ChatBot	`chatbot`	`app`	This component uses the ChatBot app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
Webhook Name	`name`	`string`	The name of the webhook, this will be used to select in the ChatBot UI flow

Trigger Authentication#

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

To retrieve your API keys,

Navigate to your ChatBot account and sign in
Go to “Settings” > “Developers” > “API keys”

Note: The client access token should be used to invoke /query endpoint. For other API endpoints use the Developer access token

About ChatBot#

ChatBot is an all-in-one platform to create, deploy, and track chatbots across channels.

Action#

Download File on Microsoft OneDrive

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

Version:0.0.9

Key:microsoft_onedrive-download-file

View on GitHub

Microsoft OneDrive Overview#

The Microsoft OneDrive API taps into the robust file storage and management capabilities of OneDrive, allowing for operations like file uploads, retrievals, sharing, and synchronization. Integrating this API into Pipedream workflows lets you automate tasks involving file management, content collaboration, and data backup processes. With OneDrive's API on Pipedream, you can streamline document workflows, trigger actions based on file changes, and connect your file storage to countless other services for enhanced productivity.

Action Code#

import fs from "fs";
import stream from "stream";
import util from "util";
import onedrive from "../../microsoft_onedrive.app.mjs";
import httpRequest from "../../common/httpRequest.mjs";
import { ConfigurationError } from "@pipedream/platform";

export default {
  name: "Download File",
  description: "Download a file stored in OneDrive. [See the documentation](https://learn.microsoft.com/en-us/onedrive/developer/rest-api/api/driveitem_get_content?view=odsp-graph-online)",
  key: "microsoft_onedrive-download-file",
  version: "0.0.9",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: true,
  },
  type: "action",
  props: {
    onedrive,
    fileId: {
      propDefinition: [
        onedrive,
        "fileId",
      ],
      optional: true,
    },
    filePath: {
      type: "string",
      label: "File Path",
      description: "The path to the file from the root folder, e.g., `Documents/My Subfolder/File 1.docx`. You can either provide this, or search for an existing file with the `File ID` prop.",
      optional: true,
    },
    newFileName: {
      type: "string",
      label: "New File Name",
      description: "The file name to save the downloaded content as, under the `/tmp` folder. Make sure to include the file extension.",
    },
    syncDir: {
      type: "dir",
      accessMode: "write",
      sync: true,
    },
  },
  methods: {
    httpRequest,
  },
  async run({ $ }) {
    const {
      fileId, filePath, newFileName,
    } = this;

    if (!fileId && !filePath) {
      throw new ConfigurationError("You must specify either **File ID** or **File Path**.");
    }

    const url = fileId
      ? `items/${fileId}/content`
      : `/root:/${encodeURI(filePath)}:/content`;
    let response;
    try {
      response = await this.httpRequest({
        $,
        url,
        responseType: "stream",
      });
    } catch {
      throw new ConfigurationError(`Error accessing file. Please make sure that the ${ fileId
        ? "File ID"
        : "File Path"} is correct.`);
    }

    const fileName = newFileName.split("/").pop();
    const tmpFilePath = `/tmp/${fileName}`;

    const pipeline = util.promisify(stream.pipeline);
    await pipeline(response, fs.createWriteStream(tmpFilePath));

    $.export("$summary", `Returned file contents and saved to \`${tmpFilePath}\`.`);
    return tmpFilePath;
  },
};

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 OneDrive	`onedrive`	`app`	This component uses the Microsoft OneDrive app.
File ID	`fileId`	`string`	Select a value from the drop down menu.
File Path	`filePath`	`string`	The path to the file from the root folder, e.g., `Documents/My Subfolder/File 1.docx`. You can either provide this, or search for an existing file with the `File ID` prop.
New File Name	`newFileName`	`string`	The file name to save the downloaded content as, under the `/tmp` folder. Make sure to include the file extension.
syncDir	`syncDir`	`dir`

Action Authentication#

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

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

User.Reademailoffline_accessopenidprofileFiles.ReadFiles.Read.AllFiles.ReadWrite