Create Document From Template with PandaDoc API on New event when the content of the URL changes. from HTTP / Webhook API

Pipedream makes it easy to connect APIs for PandaDoc, HTTP / Webhook and 2,900+ other apps remarkably fast.

Trigger workflow on

New event when the content of the URL changes. from the HTTP / Webhook API

Next, do this

Create Document From Template 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 HTTP / Webhook 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 event when the content of the URL changes. trigger
1. Connect your HTTP / Webhook account
2. Configure Watching timer
3. Configure HTTP Request Configuration
4. Configure Emit body only
5. Configure Emit as array
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
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 event when the content of the URL changes. on HTTP / Webhook

Description:Emit new event when the content of the URL changes.

Version:0.0.2

Key:http-watch-url

View on GitHub

HTTP / Webhook Overview#

Build, test, and send HTTP requests without code using your Pipedream workflows. The HTTP / Webhook action is a tool to build HTTP requests with a Postman-like graphical interface.

Point and click HTTP requests

Define the target URL, HTTP verb, headers, query parameters, and payload body without writing custom code.

$A screenshot of Pipedream's HTTP Request Configuration interface with a GET request type selected. The request URL is set to 'https://api.openai.com/v1/models'. The 'Auth' tab is highlighted, indicating that authentication is required for this request. In the headers section, there are two headers configured: 'User-Agent' is set to 'pipedream/1', and 'Authorization' is set to 'Bearer {{openai_api_key}}', showing how the OpenAI account's API key is dynamically inserted into the headers to handle authentication automatically.$

Here's an example workflow that uses the HTTP / Webhook action to send an authenticated API request to OpenAI.

Focus on integrating, not authenticating

This action can also use your connected accounts with third-party APIs. Selecting an integrated app will automatically update the request’s headers to authenticate with the app properly, and even inject your token dynamically.

Pipedream integrates with thousands of APIs, but if you can’t find a Pipedream integration simply use Environment Variables in your request headers to authenticate with.

Compatible with no code actions or Node.js and Python

The HTTP/Webhook action exports HTTP response data for use in subsequent workflow steps, enabling easy data transformation, further API calls, database storage, and more.

Response data is available for both coded (Node.js, Python) and no-code steps within your workflow.

Trigger Code#

import http from "../../http.app.mjs";
import hash from "object-hash";
import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";

export default {
  key: "http-watch-url",
  name: "New event when the content of the URL changes.",
  description: "Emit new event when the content of the URL changes.",
  version: "0.0.2",
  type: "source",
  dedupe: "unique",
  props: {
    http,
    timer: {
      type: "$.interface.timer",
      label: "Watching timer",
      description: "How often to watch the URL.",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    httpRequest: {
      type: "http_request",
      label: "HTTP Request Configuration",
      description: "HTTP Request Configuration",
      default: {
        method: "GET",
      },
    },
    emitBodyOnly: {
      label: "Emit body only",
      description: "If set as true the emitted item will contain only the response body, otherwise, it will include the request status code.",
      type: "boolean",
      default: true,
    },
    emitAsArray: {
      label: "Emit as array",
      description: "If the request responds with an array, this source will emit changes individually for each item of the array.",
      type: "boolean",
      default: false,
    },
  },
  methods: {
    getMeta(data, status) {
      if (this.emitBodyOnly) {
        return data;
      }
      return {
        data,
        status,
      };
    },
    emitArray(event, response) {
      if (!Array.isArray(response.data)) {
        return this.emitAny(event, response);
      }
      for (const item of response.data) {
        const meta = this.getMeta(item, response.status);
        this.emit(event, meta);
      }
    },
    emitAny(event, response) {
      const meta = this.getMeta(response.data, response.status);
      this.emit(event, meta);
    },
    emit(event, meta) {
      const ts = event.timestamp || Math.round(Date.now() / 1000);
      this.$emit(meta, {
        id: hash(meta),
        summary: `Requested at ${ts}`,
        ts,
      });
    },
  },
  async run(event) {
    const response = await this.httpRequest.execute();
    if (this.emitAsArray) {
      this.emitArray(event, response);
    } else {
      this.emitAny(event, response);
    }
  },
};

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
HTTP / Webhook	`http`	`app`	This component uses the HTTP / Webhook app.
Watching timer	`timer`	`$.interface.timer`	How often to watch the URL.
HTTP Request Configuration	`httpRequest`	`http_request`	HTTP Request Configuration
Emit body only	`emitBodyOnly`	`boolean`	If set as true the emitted item will contain only the response body, otherwise, it will include the request status code.
Emit as array	`emitAsArray`	`boolean`	If the request responds with an array, this source will emit changes individually for each item of the array.

Trigger Authentication#

The HTTP / Webhook API does not require authentication.

About HTTP / Webhook#

Get a unique URL where you can send HTTP or webhook requests

Action#

Create Document From Template on PandaDoc

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

Version:0.0.9

Key:pandadoc-create-document-from-template

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";

export default {
  key: "pandadoc-create-document-from-template",
  name: "Create Document From Template",
  description: "Create a Document from a PandaDoc Template. [See the documentation here](https://developers.pandadoc.com/reference/create-document-from-pandadoc-template)",
  type: "action",
  version: "0.0.9",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  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 = {};
    if (!this.templateId) {
      return props;
    }
    const {
      fields, images,
    } = 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,
      };
    }
    if (images?.length) {
      for (const image of images) {
        props[image.block_uuid] = {
          type: "string",
          label: `${image.name} URL`,
          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, images: templateImages,
    } = 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 images = [];
    if (templateImages?.length) {
      for (const image of templateImages) {
        if (this[image.block_uuid]) {
          images.push({
            name: image.name,
            urls: [
              this[image.block_uuid],
            ],
          });
        }
      }
    }

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

    $.export("$summary", `Successfully created document with template ID: ${templateId}`);
    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.
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" }`

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

About PandaDoc#

Create, Approve, Track & eSign Docs 40% Faster

More Ways to Connect PandaDoc + HTTP / Webhook#

Other Popular Integrations#

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

HTTP / Webhook + PandaDoc