Create Document From File with PandaDoc API

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

Trigger workflow on

HTTP requests, schedules and app events

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#

Create a workflow to Create Document From File with the PandaDoc API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

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
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Create Document From File with PandaDoc API on New Requests from HTTP / Webhook API

HTTP / Webhook + PandaDoc

Try it

Create Document From File with PandaDoc API on New Submission from Typeform API

Typeform + PandaDoc

Try it

Create Document From File with PandaDoc API on New Submission (Instant) from Jotform API

Jotform + PandaDoc

Try it

Create Document From File with PandaDoc API on New Custom Webhook Events from Stripe API

Stripe + PandaDoc

Try it

Create Document From File with PandaDoc API on New Scheduled Tasks from Pipedream API

Pipedream + PandaDoc

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is 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.

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

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;
  },
};

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.
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" } }`

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