Create Document From File with PandaDoc API on New Requests 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 Requests from the HTTP / Webhook 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 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 Requests trigger
1. Optional- Configure Body Only
2. Optional- Configure Response Status Code
3. Optional- Configure Response Content-Type
4. Optional- Configure Response Body
5. Connect your HTTP / Webhook account
Configure the Create Document From File action
1. Connect your PandaDoc account
2. Configure Document Name
3. Configure Recipients
4. Configure File Path or URL
5. Optional- Select a Document Folder Id
6. Optional- Configure Fields
7. Optional- Configure syncDir
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 Requests on HTTP / Webhook

Description:Get a URL and emit the full HTTP event on every request (including headers and query parameters). You can also configure the HTTP response code, body, and more.

Version:0.1.1

Key:http-new-requests

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

// Core HTTP component
export default {
  key: "http-new-requests",
  name: "New Requests",
  description: "Get a URL and emit the full HTTP event on every request (including headers and query parameters). You can also configure the HTTP response code, body, and more.",
  version: "0.1.1",
  type: "source",
  props: {
    httpInterface: {
      type: "$.interface.http",
      customResponse: true,
    },
    emitBodyOnly: {
      type: "boolean",
      label: "Body Only",
      description: "This source emits an event representing the full HTTP request by default. Select `true` to emit the body only.",
      optional: true,
      default: false,
    },
    resStatusCode: {
      type: "string",
      label: "Response Status Code",
      description: "The status code to return in the HTTP response",
      optional: true,
      default: "200",
    },
    resContentType: {
      type: "string",
      label: "Response Content-Type",
      description: "The `Content-Type` of the body returned in the HTTP response",
      optional: true,
      default: "application/json",
    },
    resBody: {
      type: "string",
      label: "Response Body",
      description: "The body to return in the HTTP response",
      optional: true,
      default: "{ \"success\": true }",
    },
    http,
  },
  async run(event) {
    const summary = `${event.method} ${event.path}`;

    this.httpInterface.respond({
      status: this.resStatusCode,
      body: this.resBody,
      headers: {
        "content-type": this.resContentType,
      },
    });

    if (this.emitBodyOnly) {
      this.$emit(event.body, {
        summary,
      });
    } else {
      this.$emit(event, {
        summary,
      });
    }
  },
};

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
N/A	`httpInterface`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
Body Only	`emitBodyOnly`	`boolean`	This source emits an event representing the full HTTP request by default. Select `true` to emit the body only.
Response Status Code	`resStatusCode`	`string`	The status code to return in the HTTP response
Response Content-Type	`resContentType`	`string`	The `Content-Type` of the body returned in the HTTP response
Response Body	`resBody`	`string`	The body to return in the HTTP response
HTTP / Webhook	`http`	`app`	This component uses the HTTP / Webhook app.

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 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:1.0.2

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: "1.0.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  props: {
    app,
    name: {
      propDefinition: [
        app,
        "name",
      ],
    },
    recipients: {
      propDefinition: [
        app,
        "recipients",
      ],
    },
    file: {
      propDefinition: [
        app,
        "file",
      ],
    },
    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,
    },
    syncDir: {
      type: "dir",
      accessMode: "read",
      sync: true,
      optional: true,
    },
  },
  methods: createDocumentAttachment.methods,
  async run({ $ }) {
    const {
      name,
      recipients,
      file,
      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");
    }

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

    const data = await this.getFormData(file);
    const 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 Path or URL	`file`	`string`	The file to upload. Provide either a file URL or a path to a file in the `/tmp` directory (for example, `/tmp/myFile.txt`)
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" } }`
syncDir	`syncDir`	`dir`

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