Create Document Attachment with PandaDoc API on New Monitor Run Completed from Postman API

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

Trigger workflow on

New Monitor Run Completed from the Postman API

Next, do this

Create Document Attachment with the PandaDoc 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 Postman trigger and PandaDoc action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Monitor Run Completed trigger
1. Connect your Postman account
2. Configure timer
3. Select a Monitor ID
Configure the Create Document Attachment action
1. Connect your PandaDoc account
2. Select a Document Id
3. Configure File
4. Configure File Name
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 Monitor Run Completed on Postman

Description:Emit new event when a monitor run is completed. [See the documentation](https://learning.postman.com/docs/monitoring-your-api/intro-monitors/)

Version:0.0.1

Key:postman-monitor-run-completed

View on GitHub

Postman Overview#

The Postman API enables you to automate tasks within your Postman collections, such as running collections, fetching and updating environments, and integrating your API development workflow into your CI/CD pipeline. Using Pipedream, you can harness this functionality to create custom workflows that trigger on various events, process data, and connect with other apps, extending the capabilities of your API testing and development processes.

Trigger Code#

import postman from "../../postman.app.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  key: "postman-monitor-run-completed",
  name: "New Monitor Run Completed",
  description: "Emit new event when a monitor run is completed. [See the documentation](https://learning.postman.com/docs/monitoring-your-api/intro-monitors/)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    postman,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: 60,
      },
    },
    monitorId: {
      propDefinition: [
        postman,
        "monitorId",
      ],
    },
  },
  methods: {
    _getLastDate() {
      return this.db.get("lastDate") || new Date("1970-01-01");
    },
    _setLastDate(lastDate) {
      this.db.set("lastDate", lastDate);
    },
    async startEvent() {
      const lastDate = this._getLastDate();

      const { monitor } = await this.postman.getMonitor({
        monitorId: this.monitorId,
      });

      if (monitor.lastRun?.status === "success" && new Date(monitor.lastRun.startedAt) > new Date(lastDate)) {
        this._setLastDate(monitor.lastRun.startedAt);
        this.emitEvent(monitor);
      }
    },
    emitEvent(monitor) {
      this.$emit(monitor, {
        id: monitor.id + monitor.lastRun.startedAt,
        summary: `Monitor Run Completed: ${monitor.name}`,
        ts: Date.parse(monitor.lastRun.finishedAt),
      });
    },
  },
  async run() {
    await this.startEvent();
  },
  sampleEmit,
};

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
Postman	`postman`	`app`	This component uses the Postman app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Monitor ID	`monitorId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

To retrieve your API key,

Navigate to your Postman account and sign in
Go to your Integration Dashboard
Click "Generate API Key", and copy and paste it below.

About Postman#

Postman is the world's leading API platform.

Action#

Create Document Attachment on PandaDoc

Description:Adds an attachment to a document. [See the documentation here](https://developers.pandadoc.com/reference/create-document-attachment)

Version:0.0.7

Key:pandadoc-create-document-attachment

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.

Action Code#

import app from "../../pandadoc.app.mjs";
import { ConfigurationError } from "@pipedream/platform";
import fs from "fs";
import path from "path";
import FormData from "form-data";

export default {
  key: "pandadoc-create-document-attachment",
  name: "Create Document Attachment",
  description: "Adds an attachment to a document. [See the documentation here](https://developers.pandadoc.com/reference/create-document-attachment)",
  type: "action",
  version: "0.0.7",
  props: {
    app,
    documentId: {
      propDefinition: [
        app,
        "documentId",
      ],
    },
    file: {
      propDefinition: [
        app,
        "file",
      ],
    },
    fileName: {
      type: "string",
      label: "File Name",
      description: "A name you want to set for a file in the system",
    },
  },
  methods: {
    isValidFile(filePath) {
      const filePathWithTmp = `/tmp/${filePath}`;
      if (fs.existsSync(filePathWithTmp)) {
        return filePathWithTmp;
      } else if (fs.existsSync(filePath)) {
        return filePath;
      }
      return false;
    },
    getFileStream(filePath) {
      return fs.createReadStream(filePath);
    },
    getFileMeta(filePath) {
      const stats = fs.statSync(filePath);
      return {
        name: path.basename(filePath),
        size: stats.size,
      };
    },
    getFormData(file, fileName) {
      const fileValidation = this.isValidFile(file);
      if (!fileValidation) {
        throw new ConfigurationError("`file` must be a valid file path!");
      }

      const fileMeta = this.getFileMeta(fileValidation);
      const fileContent = this.getFileStream(fileValidation);
      const data = new FormData();
      if (fileName) data.append("name", fileName);
      data.append("file", fileContent, {
        knownLength: fileMeta.size,
      });

      return data;
    },
  },
  async run({ $ }) {
    const {
      documentId,
      file,
      fileName,
    } = this;

    const data = this.getFormData(file, fileName);

    const response = await this.app.createDocumentAttachments({
      $,
      documentId,
      data,
      headers: {
        "Content-Type": `multipart/form-data; boundary=${data._boundary}`,
      },
    });

    $.export("$summary", `Successfully created document attachment with ID: ${response.uuid}`);
    return response;
  },
};

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
PandaDoc	`app`	`app`	This component uses the PandaDoc app.
Document Id	`documentId`	`string`	Select a value from the drop down menu.
File	`file`	`string`	The file to upload from the `/tmp` folder. See the docs here on how to upload a file to `/tmp`.
File Name	`fileName`	`string`	A name you want to set for a file in the system

Action 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

Create Document Attachment with PandaDoc API on New Monitor Run Completed from Postman API

Pipedream makes it easy to connect APIs for PandaDoc, Postman 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