Create Document From File 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 From File 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 From File action
1. Connect your PandaDoc account
2. Configure Document Name
3. Configure Recipients
4. Optional- Configure File
5. Optional- Configure File URL
6. Optional- Select a Document Folder Id
7. Optional- Configure Fields
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 From File on PandaDoc

Description:Create a document from a file or public file URL. [See the documentation here](https://developers.pandadoc.com/reference/create-document-from-pdf)

Version:0.0.8

Key:pandadoc-create-document-from-file

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 { ConfigurationError } from "@pipedream/platform";
import app from "../../pandadoc.app.mjs";
import createDocumentAttachment from "../create-document-attachment/create-document-attachment.mjs";

export default {
  key: "pandadoc-create-document-from-file",
  name: "Create Document From File",
  description: "Create a document from a file or public file URL. [See the documentation here](https://developers.pandadoc.com/reference/create-document-from-pdf)",
  type: "action",
  version: "0.0.8",
  props: {
    app,
    name: {
      propDefinition: [
        app,
        "name",
      ],
    },
    recipients: {
      propDefinition: [
        app,
        "recipients",
      ],
    },
    file: {
      propDefinition: [
        app,
        "file",
      ],
      optional: true,
    },
    fileUrl: {
      type: "string",
      label: "File URL",
      description: "A public file URL to use instead of a local file.",
      optional: true,
    },
    documentFolderId: {
      propDefinition: [
        app,
        "documentFolderId",
      ],
    },
    fields: {
      type: "string",
      label: "Fields",
      description: `A \`fields\` object containing fields to add to the document. [See the documentation](https://developers.pandadoc.com/reference/create-document-from-pdf) for more information about fields.
      \nE.g. \`{ "name": { "value": "Jane", "role": "user" }, "like": { "value": true, "role": "user" } }\``,
      optional: true,
    },
  },
  methods: createDocumentAttachment.methods,
  async run({ $ }) {
    const {
      name,
      recipients,
      file,
      fileUrl,
      documentFolderId,
    } = this;

    let parsedRecipients;
    try {
      parsedRecipients = recipients.map((s) => JSON.parse(s));
    } catch (err) {
      throw new ConfigurationError("**Error parsing recipients** - each must be a valid JSON-stringified object");
    }

    let data, contentType, json = {
      name,
      recipients: parsedRecipients,
      folder_uuid: documentFolderId,
    };
    if (this.fields) {
      json.parse_form_fields = true;
      json.fields = typeof this.fields === "string"
        ? JSON.parse(this.fields)
        : this.fields;
    }

    if (fileUrl) {
      data = json;
      contentType = "application/json";
      data.url = fileUrl;
    } else {
      data = this.getFormData(file);
      contentType = `multipart/form-data; boundary=${data._boundary}`;
      data.append("data", JSON.stringify(json));
    }

    const response = await this.app.createDocument({
      $,
      data,
      headers: {
        "Content-Type": contentType,
      },
    });

    $.export("$summary", `Successfully created document 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 Name	`name`	`string`	Specify the document's name.
Recipients	`recipients`	`string[]`	The list of recipients you're sending the document to. Every object must contain the email parameter. The role, first_name and last_name parameters are optional. If the role parameter passed, a person is assigned all fields matching their corresponding role. If not passed, a person will receive a read-only link to view the document. If the first_name and last_name not passed the system: 1. creates a new contact, if none exists with the given email; or 2. gets the existing contact with the given email that already exists. E.g. `{ "email": "john.doe@pipedream.com", "first_name": "John", "last_name": "Doe", "role": "user" }`
File	`file`	`string`	The file to upload from the `/tmp` folder. See the docs here on how to upload a file to `/tmp`.
File URL	`fileUrl`	`string`	A public file URL to use instead of a local file.
Document Folder Id	`documentFolderId`	`string`	Select a value from the drop down menu.
Fields	`fields`	`string`	A `fields` object containing fields to add to the document. See the documentation for more information about fields. E.g. `{ "name": { "value": "Jane", "role": "user" }, "like": { "value": true, "role": "user" } }`

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 From File 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