Share File or Folder with Google Drive API on Document State Changed (Instant) from PandaDoc API

Pipedream makes it easy to connect APIs for Google Drive, PandaDoc and 2,400+ other apps remarkably fast.

Trigger workflow on

Document State Changed (Instant) from the PandaDoc API

Next, do this

Share File or Folder with the Google Drive 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 PandaDoc trigger and Google Drive action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the Document State Changed (Instant) trigger
1. Connect your PandaDoc account
Configure the Share File or Folder action
1. Connect your Google Drive account
2. Optional- Select a Drive
3. Optional- Select a File
4. Optional- Select a Folder
5. Select a Type
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#

Document State Changed (Instant) on PandaDoc

Description:Emit new event when a document's state is changed. [See the documentation here](https://developers.pandadoc.com/reference/create-webhooks-subscription)

Version:0.0.5

Key:pandadoc-document-state-changed

View on GitHub

PandaDoc Overview#

The PandaDoc API opens up a realm of possibilities for automating document workflows, creating a seamless bridge between document management and various business processes. With it, you can programmatically create, send, and track documents, streamline electronic signatures, and manage templates, among others. Integrations through Pipedream can harness these capabilities, enabling you to trigger actions in PandaDoc based on events from other apps, or vice versa.

Trigger Code#

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

const DOCS_LINK = "https://developers.pandadoc.com/reference/create-webhooks-subscription";

export default {
  ...common,
  name: "Document State Changed (Instant)",
  description:
    `Emit new event when a document's state is changed. [See the documentation here](${DOCS_LINK})`,
  key: "pandadoc-document-state-changed",
  version: "0.0.5",
  type: "source",
  methods: {
    ...common.methods,
    getHookName() {
      return "Document State Changed";
    },
    getHookTypes() {
      return [
        "document_state_changed",
      ];
    },
  },
};

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
PandaDoc	`app`	`app`	This component uses the PandaDoc 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.

Trigger Authentication#

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

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

read+write

About PandaDoc#

Create, Approve, Track & eSign Docs 40% Faster

Action#

Share File or Folder on Google Drive

Description:Add a [sharing permission](https://support.google.com/drive/answer/7166529) to the sharing preferences of a file or folder and provide a sharing URL. [See the documentation](https://developers.google.com/drive/api/v3/reference/permissions/create)

Version:0.1.9

Key:google_drive-add-file-sharing-preference

View on GitHub

Google Drive Overview#

The Google Drive API on Pipedream allows you to automate various file management tasks, such as creating, reading, updating, and deleting files within your Google Drive. You can also share files, manage permissions, and monitor changes to files and folders. This opens up possibilities for creating workflows that seamlessly integrate with other apps and services, streamlining document handling, backup processes, and collaborative workflows.

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import {
  GOOGLE_DRIVE_GRANTEE_DOMAIN,
  GOOGLE_DRIVE_GRANTEE_GROUP,
  GOOGLE_DRIVE_GRANTEE_USER,
  GOOGLE_DRIVE_ROLE_OPTIONS,
  GOOGLE_DRIVE_ROLE_OPTION_FILEORGANIZER,
  GOOGLE_DRIVE_ROLE_WRITER,
} from "../../common/constants.mjs";
import googleDrive from "../../google_drive.app.mjs";

/**
 * Uses Google Drive API to create a permission for a file. The role granted by
 * the permission is one of `owner`,`organizer`,`fileOrganizer`,
 * `writer`,`commenter`, `reader`. See the [Google Drive API Reference for
 * Permissions](https://bit.ly/2XKKG1X) for more information.
 */
export default {
  key: "google_drive-add-file-sharing-preference",
  name: "Share File or Folder",
  description:
    "Add a [sharing permission](https://support.google.com/drive/answer/7166529) to the sharing preferences of a file or folder and provide a sharing URL. [See the documentation](https://developers.google.com/drive/api/v3/reference/permissions/create)",
  version: "0.1.9",
  type: "action",
  props: {
    googleDrive,
    drive: {
      propDefinition: [
        googleDrive,
        "watchedDrive",
      ],
      optional: true,
    },
    fileId: {
      propDefinition: [
        googleDrive,
        "fileId",
        (c) => ({
          drive: c.drive,
        }),
      ],
      optional: true,
      description: "The file to share. You must specify either a file or a folder.",
    },
    folderId: {
      propDefinition: [
        googleDrive,
        "folderId",
        (c) => ({
          drive: c.drive,
        }),
      ],
      optional: true,
      description: "The folder to share. You must specify either a file or a folder.",
    },
    type: {
      propDefinition: [
        googleDrive,
        "type",
      ],
      reloadProps: true,
    },
  },
  async additionalProps() {
    const obj = {};
    const {
      fileId, folderId, type,
    } = this;
    if (!(fileId || folderId) || !type) return obj;

    const emailAddress = {
      type: "string",
      label: "Email Address",
      description:
        "Enter the email address of the user that you'd like to share the file or folder with (e.g. `alex@altostrat.com`).",
    };

    switch (type) {
    case GOOGLE_DRIVE_GRANTEE_DOMAIN:
      obj.domain = {
        type: "string",
        label: "Domain",
        description:
            "Enter the domain of the G Suite organization that you'd like to share the file or folder with (e.g. `altostrat.com`). All G Suite organization users under this domain will have access to the file you share.",
      };
      break;
    case GOOGLE_DRIVE_GRANTEE_GROUP:
      obj.emailAddress = {
        ...emailAddress,
        description:
            "Enter the email address of the group that you'd like to share the file or folder with (e.g. `hiking-club@altostrat.com`)",
      };
      break;
    case GOOGLE_DRIVE_GRANTEE_USER:
      obj.emailAddress = emailAddress;
      break;

    default:
      break;
    }

    const isFolder = !!folderId;
    const options = GOOGLE_DRIVE_ROLE_OPTIONS;

    if (isFolder) {
      const writerOpt = options.find(({ value }) => value === GOOGLE_DRIVE_ROLE_WRITER);
      writerOpt.label = writerOpt.label.replace(/Writer/, "Contributor");
      options.push(GOOGLE_DRIVE_ROLE_OPTION_FILEORGANIZER);
    }

    return {
      ...obj,
      role: {
        type: "string",
        label: "Role",
        description: "The role granted by this permission",
        options,
      },
    };
  },
  async run({ $ }) {
    const {
      fileId, folderId, role, type, domain, emailAddress,
    } = this;
    if (!(fileId || folderId)) {
      throw new ConfigurationError("You must specify either a file or a folder");
    }
    // Create the permission for the file
    await this.googleDrive.createPermission(folderId ?? fileId, {
      role,
      type,
      domain,
      emailAddress,
    });

    // Get the file to get the `webViewLink` sharing URL
    const resp = await this.googleDrive.getFile(folderId ?? fileId);
    const webViewLink = resp.webViewLink;
    $.export(
      "$summary",
      `Successfully shared ${folderId
        ? "folder"
        : "file"} "${resp.name}" with ${type} "${
        emailAddress ?? domain ?? ""
      }" with role '${role}'`,
    );
    return webViewLink;
  },
};

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
Google Drive	`googleDrive`	`app`	This component uses the Google Drive app.
Drive	`drive`	`string`	Select a value from the drop down menu.
File	`fileId`	`string`	Select a value from the drop down menu.
Folder	`folderId`	`string`	Select a value from the drop down menu.
Type	`type`	`string`	Select a value from the drop down menu:`usergroupdomainanyone`

Action Authentication#

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

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

https://www.googleapis.com/auth/drive

Share File or Folder with Google Drive API on Document State Changed (Instant) from PandaDoc API

Pipedream makes it easy to connect APIs for Google Drive, PandaDoc and 2,400+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,400+apps by most popular

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