Create Document From Template with PandaDoc API

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

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Create Document From Template with the PandaDoc API

No credit card required

▶

Watch us build a workflow

4 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

Create a workflow to Create Document From Template 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 Template action
1. Connect your PandaDoc account
2. Configure Document Name
3. Select a Template Id
4. Optional- Select a Document Folder Id
5. Optional- Configure Tags
6. Configure Recipients
7. Optional- Configure Tokens
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 Template with PandaDoc API on New Monitor Run Completed from Postman API

Postman + PandaDoc

Try it

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

HTTP / Webhook + PandaDoc

Try it

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

Typeform + PandaDoc

Try it

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

Jotform + PandaDoc

Try it

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

Stripe + 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 Template on PandaDoc

Description:Create Document from PandaDoc Template. [See the docs here](https://developers.pandadoc.com/reference/create-document-from-pandadoc-template)

Version:0.0.6

Key:pandadoc-create-document-from-template

View on GitHub

Code#

import app from "../../pandadoc.app.mjs";

export default {
  key: "pandadoc-create-document-from-template",
  name: "Create Document From Template",
  description: "Create Document from PandaDoc Template. [See the docs here](https://developers.pandadoc.com/reference/create-document-from-pandadoc-template)",
  type: "action",
  version: "0.0.6",
  props: {
    app,
    name: {
      propDefinition: [
        app,
        "name",
      ],
    },
    templateId: {
      propDefinition: [
        app,
        "templateId",
      ],
      reloadProps: true,
      description: "The ID of a template you want to use. Note: if you want to **prefill fields in your template**, you need to map your template fields to the API fields following [the instruction here](https://developers.pandadoc.com/reference/create-document-from-pandadoc-template#prefilled-fields)",
    },
    documentFolderId: {
      propDefinition: [
        app,
        "documentFolderId",
      ],
    },
    tags: {
      type: "string[]",
      label: "Tags",
      description: "Mark your document with one or several tags.",
      optional: true,
    },
    recipients: {
      propDefinition: [
        app,
        "recipients",
      ],
    },
    tokens: {
      type: "string[]",
      label: "Tokens",
      description: `You may pass a list of tokens/values to pre-fill tokens (variables) used in a template. 
      Name is a token (variable) name in a template. 
      Value is a real value you would like to replace a token (variable) with.
      \n\nE.g. \`{ "name": "Favorite.Pet", "value": "Dog Doe" }\``,
      optional: true,
    },
  },
  async additionalProps() {
    const props = {};
    const { fields } = await this.app.getTemplate({
      templateId: this.templateId,
    });
    for (const field of fields) {
      if (!field.merge_field) {
        continue;
      }
      props[field.merge_field] = {
        type: "string",
        label: `Field ${field.merge_field}`,
        optional: true,
      };
    }
    return props;
  },
  methods: {
    parseToAnyArray(arr) {
      if (!arr) {
        return undefined;
      }
      return arr.map((item) => {
        if (typeof (item) === "string") {
          return JSON.parse(item);
        }
        return item;
      });
    },
  },
  async run({ $ }) {
    const {
      name,
      templateId,
      documentFolderId,
      tags,
      recipients,
      tokens,
    } = this;

    const fields = {};
    const { fields: items } = await this.app.getTemplate({
      templateId: this.templateId,
    });
    for (const field of items) {
      if (!field.merge_field) {
        continue;
      }
      fields[field.merge_field] = {
        value: this[field.merge_field],
      };
    }

    const response = await this.app.createDocument({
      $,
      data: {
        name,
        template_uuid: templateId,
        folder_uuid: documentFolderId,
        tags,
        recipients: this.parseToAnyArray(recipients),
        tokens: this.parseToAnyArray(tokens),
        fields,
      },
    });

    $.export("$summary", `Successfully created document with template ID: ${templateId}`);
    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.
Template Id	`templateId`	`string`	Select a value from the drop down menu.
Document Folder Id	`documentFolderId`	`string`	Select a value from the drop down menu.
Tags	`tags`	`string[]`	Mark your document with one or several tags.
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" }`
Tokens	`tokens`	`string[]`	You may pass a list of tokens/values to pre-fill tokens (variables) used in a template. Name is a token (variable) name in a template. Value is a real value you would like to replace a token (variable) with. E.g. `{ "name": "Favorite.Pet", "value": "Dog Doe" }`

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