Get PDF with Puppeteer API on New Events (Instant) from Twilio SendGrid API

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

Trigger workflow on

New Events (Instant) from the Twilio SendGrid API

Next, do this

Get PDF with the Puppeteer 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 Twilio SendGrid trigger and Puppeteer action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Events (Instant) trigger
1. Connect your Twilio SendGrid account
2. Select one or more Event Types
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
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 Events (Instant) on Twilio SendGrid

Description:Emit new event when any of the specified SendGrid events is received

Version:0.0.5

Key:sendgrid-events

View on GitHub

Twilio SendGrid Overview#

The Twilio SendGrid API opens up a world of possibilities for email automation, enabling you to send emails efficiently and track their performance. With this API, you can programmatically create and send personalized email campaigns, manage contacts, and parse inbound emails for data extraction. When you harness the power of Pipedream, you can connect SendGrid to hundreds of other apps to automate workflows, such as triggering email notifications based on specific actions, syncing email stats with your analytics, or handling incoming emails to create tasks or tickets.

Trigger Code#

import common from "../common/http-based.mjs";
import deliveryEventTypes from "./delivery-event-types.mjs";
import engagementEventTypes from "./engagement-event-types.mjs";

export default {
  ...common,
  key: "sendgrid-events",
  name: "New Events (Instant)",
  description: "Emit new event when any of the specified SendGrid events is received",
  version: "0.0.5",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    eventTypes: {
      type: "string[]",
      label: "Event Types",
      description: "The type of events to listen to",
      options(context) {
        const { page } = context;
        if (page !== 0) {
          return {
            options: [],
          };
        }

        const options = [
          ...deliveryEventTypes,
          ...engagementEventTypes,
        ];
        return {
          options,
        };
      },
    },
  },
  methods: {
    ...common.methods,
    baseWebhookSettings() {
      // The list of events that a webhook can listen to. This method returns an
      // exhaustive list of all such flags disabled, and each event source can
      // then override the flags that are relevant to the event they handle.
      //
      // See the docs for more information:
      // https://sendgrid.com/docs/api-reference/
      const eventTypesData = [
        ...deliveryEventTypes,
        ...engagementEventTypes,
      ];
      return eventTypesData.reduce((accum, eventTypeData) => ({
        ...accum,
        [eventTypeData.value]: false,
      }), {});
    },
    webhookEventFlags() {
      return this.eventTypes.reduce((accum, eventType) => ({
        ...accum,
        [eventType]: true,
      }), {});
    },
    generateMeta(data) {
      const {
        event: eventType,
        sg_event_id: id,
        timestamp: ts,
      } = data;
      const summary = `New event: ${eventType}`;
      return {
        id,
        summary,
        ts,
      };
    },
  },
};

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	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Twilio SendGrid	`sendgrid`	`app`	This component uses the Twilio SendGrid app.
N/A	`http`	`$.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.
Event Types	`eventTypes`	`string[]`	Select a value from the drop down menu.

Trigger Authentication#

Twilio SendGrid uses API keys for authentication. When you connect your Twilio SendGrid account, Pipedream securely stores the keys so you can easily authenticate to Twilio SendGrid APIs in both code and no-code steps.

About 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.

Action#

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

View on GitHub

Puppeteer Overview#

Puppeteer is a Node.js library which provides a high-level API to control Chrome/Chromium over the DevTools Protocol. Puppeteer runs in headless mode on Chromium on Pipedream.

Using Puppeteer you can perform tasks including:

Capture Screenshots: Convert webpages into images.
Processing PDFs: parse and scan PDFs.
Web Scraping: Extract data from websites.
UI/UX Testing: Verify user interface and experience.
Integration with Test Frameworks: Combine with testing frameworks.
Task Automation: Automate web-related tasks like form filling.
Functional Testing: Automate user interactions to test web application functionality.
Regression Testing: Ensure new code changes don't introduce bugs.

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

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
Puppeteer	`puppeteer`	`app`	This component uses the Puppeteer app.
URL	`url`	`string`	The URL of the page to scrape. For example, `https://example.com`.
Download Path	`downloadPath`	`string`	Download the PDF to the `/tmp` directory with the specified filename
Display Header Footer	`displayHeaderFooter`	`boolean`	Whether to show the header and footer.
Footer Template	`footerTemplate`	`string`	HTML template for the print footer.
Format	`format`	`string`	Select 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 Template	`headerTemplate`	`string`	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.
Height	`height`	`string`	Sets the height of paper. You can pass in a number or a string with a unit.
Landscape	`landscape`	`boolean`	Whether to print in landscape orientation.
Bottom Margin	`marginBottom`	`string`	Margin for the bottom of the page
Left Margin	`marginLeft`	`string`	Margin for the left side of the page
Right Margin	`marginRight`	`string`	Margin for the right side of the page
Top Margin	`marginTop`	`string`	Margin for the top of the page
Omit Background	`omitBackground`	`boolean`	Hides default white background and allows generating pdfs with transparency.
Page Ranges	`pageRanges`	`string`	Paper ranges to print, e.g. 1-5, 8, 11-13.
Prefer CSS Page Size	`preferCSSPageSize`	`boolean`	Give any CSS @page size declared in the page priority over what is declared in the width or height or format option.
Print Background	`printBackground`	`boolean`	Set to true to print background graphics.
Scale	`scale`	`string`	Scales the rendering of the web page. Amount must be between 0.1 and 2.
Timeout	`timeout`	`integer`	Timeout in milliseconds. Pass 0 to disable timeout.
Width	`width`	`string`	Sets the width of paper. You can pass in a number or a string with a unit.