← Puppeteer

Get PDF with Puppeteer API

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

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Get PDF with the Puppeteer API
No credit card required
Intro to Pipedream
Watch us build a workflow
Watch us build a workflow
8 min
Watch now ➜

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

Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo
Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo

Developers Pipedream

Getting Started

Create a workflow to Get PDF with the Puppeteer API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the Get PDF action
    1. Connect your Puppeteer account
    2. Configure URL
    3. Optional- Configure Download Path
    4. Optional- Configure Display Header Footer
    5. Optional- Configure Footer Template
    6. Optional- Select a Format
    7. Optional- Configure Header Template
    8. Optional- Configure Height
    9. Optional- Configure Landscape
    10. Optional- Configure Bottom Margin
    11. Optional- Configure Left Margin
    12. Optional- Configure Right Margin
    13. Optional- Configure Top Margin
    14. Optional- Configure Omit Background
    15. Optional- Configure Page Ranges
    16. Optional- Configure Prefer CSS Page Size
    17. Optional- Configure Print Background
    18. Optional- Configure Scale
    19. Optional- Configure Timeout
    20. Optional- Configure Width
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Integrations

Get PDF with Puppeteer API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + Puppeteer
 
Try it
Get PDF with Puppeteer API on New Submission from Typeform API
Typeform + Puppeteer
 
Try it
Get PDF with Puppeteer API on Custom Events from Zoom API
Zoom + Puppeteer
 
Try it
Get PDF with Puppeteer API on New Submission (Instant) from Jotform API
Jotform + Puppeteer
 
Try it
Get PDF with Puppeteer API on New Scheduled Tasks from Pipedream API
Pipedream + Puppeteer
 
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.

Get PDF on Puppeteer
Description:Generate a PDF of a page using Puppeteer. [See the documentation](https://pptr.dev/api/puppeteer.page.pdf)
Version:1.0.2
Key:puppeteer-get-pdf

Code

import puppeteer from "../../puppeteer.app.mjs";
import constants from "../../common/constants.mjs";
import common from "../common/common.mjs";
import fs from "fs";

export default {
  ...common,
  key: "puppeteer-get-pdf",
  name: "Get PDF",
  description:
    "Generate a PDF of a page using Puppeteer. [See the documentation](https://pptr.dev/api/puppeteer.page.pdf)",
  version: "1.0.2",
  type: "action",
  props: {
    puppeteer,
    ...common.props,
    downloadPath: {
      type: "string",
      label: "Download Path",
      description:
        "Download the PDF to the `/tmp` directory with the specified filename",
      optional: true,
    },
    displayHeaderFooter: {
      type: "boolean",
      label: "Display Header Footer",
      description: "Whether to show the header and footer.",
      optional: true,
      default: false,
    },
    footerTemplate: {
      type: "string",
      label: "Footer Template",
      description: "HTML template for the print footer.",
      optional: true,
    },
    format: {
      type: "string",
      label: "Format",
      description: "The paper format of the PDF",
      options: constants.PAPER_FORMAT,
      optional: true,
    },
    headerTemplate: {
      type: "string",
      label: "Header Template",
      description:
        "HTML template for the print header. Should be valid HTML with the following classes used to inject values into them: `date` - formatted print date, `title` - document title, `url` - document location, `pageNumber` - current page number, `totalPages` - total pages in the document.",
      optional: true,
    },
    height: {
      type: "string",
      label: "Height",
      description:
        "Sets the height of paper. You can pass in a number or a string with a unit.",
      optional: true,
    },
    landscape: {
      type: "boolean",
      label: "Landscape",
      description: "Whether to print in landscape orientation.",
      optional: true,
      default: false,
    },
    marginBottom: {
      type: "string",
      label: "Bottom Margin",
      description: "Margin for the bottom of the page",
      optional: true,
    },
    marginLeft: {
      type: "string",
      label: "Left Margin",
      description: "Margin for the left side of the page",
      optional: true,
    },
    marginRight: {
      type: "string",
      label: "Right Margin",
      description: "Margin for the right side of the page",
      optional: true,
    },
    marginTop: {
      type: "string",
      label: "Top Margin",
      description: "Margin for the top of the page",
      optional: true,
    },
    omitBackground: {
      type: "boolean",
      label: "Omit Background",
      description:
        "Hides default white background and allows generating pdfs with transparency.",
      optional: true,
      default: false,
    },
    pageRanges: {
      type: "string",
      label: "Page Ranges",
      description: "Paper ranges to print, e.g. 1-5, 8, 11-13.",
      optional: true,
    },
    preferCSSPageSize: {
      type: "boolean",
      label: "Prefer CSS Page Size",
      description:
        "Give any CSS @page size declared in the page priority over what is declared in the width or height or format option.",
      optional: true,
      default: false,
    },
    printBackground: {
      type: "boolean",
      label: "Print Background",
      description: "Set to true to print background graphics.",
      optional: true,
      default: false,
    },
    scale: {
      type: "string",
      label: "Scale",
      description:
        "Scales the rendering of the web page. Amount must be between 0.1 and 2.",
      optional: true,
    },
    timeout: {
      type: "integer",
      label: "Timeout",
      description: "Timeout in milliseconds. Pass 0 to disable timeout.",
      optional: true,
      default: 30000,
    },
    width: {
      type: "string",
      label: "Width",
      description:
        "Sets the width of paper. You can pass in a number or a string with a unit.",
      optional: true,
    },
  },
  methods: {
    async downloadToTMP(pdf) {
      const path = this.downloadPath.includes("/tmp")
        ? this.downloadPath
        : `/tmp/${this.downloadPath}`;
      fs.writeFileSync(path, pdf);
      return path;
    },
  },
  async run({ $ }) {
    const options = {
      displayHeaderFooter: this.displayHeaderFooter,
      footerTemplate: this.footerTemplate,
      format: this.format,
      headerTemplate: this.headerTemplate,
      height: this.height,
      landscape: this.landscape,
      margin: {
        bottom: this.marginBottom,
        left: this.marginLeft,
        right: this.marginRight,
        top: this.marginTop,
      },
      omitBackground: this.omitBackground,
      pageRanges: this.pageRanges,
      preferCSSPageSize: this.preferCSSPageSize,
      printBackground: this.printBackground,
      scale: this.scale
        ? parseFloat(this.scale)
        : undefined,
      timeout: this.timeout,
      width: this.width,
    };

    const url = this.normalizeUrl();
    const browser = await this.puppeteer.launch();
    const page = await browser.newPage();
    await page.goto(url);
    const pdf = await page.pdf(options);
    await browser.close();

    const filePath =
      pdf && this.downloadPath
        ? await this.downloadToTMP(pdf)
        : undefined;

    if (pdf) {
      $.export("$summary", `Successfully generated PDF from ${url}`);
    }

    return filePath
      ? {
        pdf,
        filePath,
      }
      : pdf;
  },
};

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.
LabelPropTypeDescription
PuppeteerpuppeteerappThis component uses the Puppeteer app.
URLurlstring

The URL of the page to scrape. For example, https://example.com.

Download PathdownloadPathstring

Download the PDF to the /tmp directory with the specified filename

Display Header FooterdisplayHeaderFooterboolean

Whether to show the header and footer.

Footer TemplatefooterTemplatestring

HTML template for the print footer.

FormatformatstringSelect a value from the drop down menu:{ "value": "letter", "label": "Letter - 8.5in x 11in" }{ "value": "legal", "label": "Legal - 8.5in x 14in" }{ "value": "tabloid", "label": "Tabloid - 11in x 17in" }{ "value": "ledger", "label": "Ledger - 17in x 11in" }{ "value": "a0", "label": "A0 - 33.1in x 46.8in" }{ "value": "a1", "label": "A1 - 23.4in x 33.1in" }{ "value": "a2", "label": "A2 - 16.54in x 23.4in" }{ "value": "a3", "label": "A3 - 11.7in x 16.54in" }{ "value": "a4", "label": "A4 - 8.27in x 11.7in" }{ "value": "a5", "label": "A5 - 5.83in x 8.27in" }{ "value": "a6", "label": "A6 - 4.13in x 5.83in" }
Header TemplateheaderTemplatestring

HTML template for the print header. Should be valid HTML with the following classes used to inject values into them: date - formatted print date, title - document title, url - document location, pageNumber - current page number, totalPages - total pages in the document.

Heightheightstring

Sets the height of paper. You can pass in a number or a string with a unit.

Landscapelandscapeboolean

Whether to print in landscape orientation.

Bottom MarginmarginBottomstring

Margin for the bottom of the page

Left MarginmarginLeftstring

Margin for the left side of the page

Right MarginmarginRightstring

Margin for the right side of the page

Top MarginmarginTopstring

Margin for the top of the page

Omit BackgroundomitBackgroundboolean

Hides default white background and allows generating pdfs with transparency.

Page RangespageRangesstring

Paper ranges to print, e.g. 1-5, 8, 11-13.

Prefer CSS Page SizepreferCSSPageSizeboolean

Give any CSS @page size declared in the page priority over what is declared in the width or height or format option.

Print BackgroundprintBackgroundboolean

Set to true to print background graphics.

Scalescalestring

Scales the rendering of the web page. Amount must be between 0.1 and 2.

Timeouttimeoutinteger

Timeout in milliseconds. Pass 0 to disable timeout.

Widthwidthstring

Sets the width of paper. You can pass in a number or a string with a unit.

Authentication

The Puppeteer API does not require authentication.

About Puppeteer

Puppeteer is a Node.js library which provides a high-level API to control Chrome/Chromium over the DevTools Protocol.

More Ways to Use Puppeteer

Actions

Get HTML with the Puppeteer API

Get the HTML of a webpage using Puppeteer. See the documentation for details.

 
Try it
Get Page Title with the Puppeteer API

Get the title of a webpage using Puppeteer. See the documentation

 
Try it
Screenshot a Page with the Puppeteer API

Captures a screenshot of a page using Puppeteer. See the documentation

 
Try it

Explore Other Apps

1
-
24
of
2,400+
apps by most popular

HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
Node
Node
Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.
Python
Python
Anything you can do in Python can be done in a Pipedream Workflow. This includes using any of the 350,000+ PyPi packages available in your Python powered workflows.
OpenAI (ChatGPT)
OpenAI (ChatGPT)
OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular models like ChatGPT, DALL-E, and Whisper.
Premium
Salesforce
Salesforce
Web services API for interacting with Salesforce
Premium
HubSpot
HubSpot
HubSpot's CRM platform contains the marketing, sales, service, operations, and website-building software you need to grow your business.
Premium
Zoho CRM
Zoho CRM
Zoho CRM is an online Sales CRM software that manages your sales, marketing, and support in one CRM platform.
Premium
Stripe
Stripe
Stripe powers online and in-person payment processing and financial solutions for businesses of all sizes.
Shopify
Shopify
Shopify is a complete commerce platform that lets anyone start, manage, and grow a business. You can use Shopify to build an online store, manage sales, market to customers, and accept payments in digital and physical locations.
Premium
WooCommerce
WooCommerce
WooCommerce is the open-source ecommerce platform for WordPress.
Premium
Snowflake
Snowflake
A data warehouse built for the cloud
Premium
MongoDB
MongoDB
MongoDB is an open source NoSQL database management program.
Supabase
Supabase
Supabase is an open source Firebase alternative.
MySQL
MySQL
MySQL is an open-source relational database management system.
PostgreSQL
PostgreSQL
PostgreSQL is a free and open-source relational database management system emphasizing extensibility and SQL compliance.
Premium
AWS
AWS
Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.
Premium
Twilio SendGrid
Twilio SendGrid
Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.
Amazon SES
Amazon SES
Amazon SES is a cloud-based email service provider that can integrate into any application for high volume email automation
Premium
Klaviyo
Klaviyo
Email Marketing and SMS Marketing Platform
Premium
Zendesk
Zendesk
Zendesk is award-winning customer service software trusted by 200K+ customers. Make customers happy via text, mobile, phone, email, live chat, social media.
Notion
Notion
Notion is a new tool that blends your everyday work apps into one. It's the all-in-one workspace for you and your team.
Slack
Slack
Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.
Microsoft Teams
Microsoft Teams
Microsoft Teams has communities, events, chats, channels, meetings, storage, tasks, and calendars in one place.
Schedule
Schedule
Trigger workflows on an interval or cron schedule.