Generate PDF with HTML 2 PDF API on New Contact from Twilio SendGrid API

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

Trigger workflow on

New Contact from the Twilio SendGrid API

Next, do this

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

Select this integration
Configure the New Contact trigger
1. Connect your Twilio SendGrid account
2. Configure timer
Configure the Generate PDF action
1. Connect your HTML 2 PDF account
2. Optional- Configure URL
3. Optional- Configure HTML
4. Optional- Configure Header
5. Optional- Configure Footer
6. Optional- Configure Page Offset
7. Optional- Select a Page Size
8. Optional- Select a Orientation
9. Optional- Configure Width
10. Optional- Configure Height
11. Optional- Configure Top Margin
12. Optional- Configure Bottom Margin
13. Optional- Configure Left
14. Optional- Configure Right
15. Optional- Select a Unit
16. Optional- Select a CSS Media Type
17. Optional- Configure Optimize Layout
18. Optional- Configure Lazy Load
19. Optional- Configure Wait Time
20. Optional- Configure CSS
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 Contact on Twilio SendGrid

Description:Emit new event when a new contact is created

Version:0.0.7

Key:sendgrid-new-contact

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 orderBy from "lodash/orderBy.js";
import common from "../common/timer-based.mjs";

export default {
  ...common,
  key: "sendgrid-new-contact",
  name: "New Contact",
  description: "Emit new event when a new contact is created",
  version: "0.0.7",
  type: "source",
  dedupe: "unique",
  hooks: {
    async activate() {
      const currentTimestamp = Date.now();
      const state = {
        processedItems: [],
        lowerTimestamp: currentTimestamp,
        upperTimestamp: currentTimestamp,
      };
      this.db.set("state", state);
    },
  },
  methods: {
    ...common.methods,
    _maxDelayTime() {
      // There is no report from SendGrid as to how much time it takes
      // for a contact to be created and appear in search results, so
      // we're using a rough estimate of 30 minutes here.
      return 30 * 60 * 1000;  // 30 minutes, in milliseconds
    },
    _addDelayOffset(timestamp) {
      return timestamp - this._maxDelayTime();
    },
    _cleanupOldProcessedItems(processedItems, currentTimestamp) {
      return processedItems
        .map((item) => ({
          // We just need to keep track of the record ID and
          // its creation date.
          id: item.id,
          created_at: item.created_at,
        }))
        .filter((item) => {
          const { created_at: createdAt } = item;
          const createdAtTimestamp = Date.parse(createdAt);
          const cutoffTimestamp = this._addDelayOffset(currentTimestamp);
          return createdAtTimestamp > cutoffTimestamp;
        });
    },
    _makeSearchQuery(processedItems, lowerTimestamp, upperTimestamp) {
      const idList = processedItems
        .map((item) => item.id)
        .map((id) => `'${id}'`)
        .join(", ")
      || "''";
      const startTimestamp = this._addDelayOffset(lowerTimestamp);
      const startDate = this.toISOString(startTimestamp);
      const endDate = this.toISOString(upperTimestamp);
      return `
        contact_id NOT IN (${idList}) AND
        created_at BETWEEN
          TIMESTAMP '${startDate}' AND
          TIMESTAMP '${endDate}'
      `;
    },
    generateMeta(data) {
      const {
        item,
        eventTimestamp: ts,
      } = data;
      const {
        id,
        email,
      } = item;
      const slugifiedEmail = this.slugifyEmail(email);
      const summary = `New contact: ${slugifiedEmail}`;
      return {
        id,
        summary,
        ts,
      };
    },
    async processEvent(event) {
      // Transform the timer timestamp to milliseconds
      // to be consistent with how Javascript handles timestamps.
      const eventTimestamp = event.timestamp * 1000;

      // Retrieve the current state of the component.
      const {
        processedItems,
        lowerTimestamp,
        upperTimestamp,
      } = this.db.get("state");

      // Search for contacts within a specific timeframe, excluding
      // items that have already been processed.
      const query = this._makeSearchQuery(processedItems, lowerTimestamp, upperTimestamp);
      const {
        result: items,
        contact_count: contactCount,
      } = await this.sendgrid.searchContacts(query);

      // If no contacts have been retrieved via the API,
      // move the time window forward to possibly capture newer contacts.
      if (contactCount === 0) {
        const newState = {
          processedItems: this._cleanupOldProcessedItems(processedItems, lowerTimestamp),
          lowerTimestamp: upperTimestamp,
          upperTimestamp: eventTimestamp,
        };
        this.db.set("state", newState);
        return;
      }

      // We process the searched records from oldest to newest.
      const itemsToProcess = orderBy(items, "created_at");
      itemsToProcess
        .forEach((item) => {
          const meta = this.generateMeta({
            item,
            eventTimestamp,
          });
          this.$emit(item, meta);
        });

      // Use the timestamp of the last processed record as a lower bound for
      // following searches. This bound will be subjected to an offset so in
      // case older records appear in future search results, but have not
      // appeared until now, can be processed. We only adjust it if it means
      // moving forward, not backwards. Otherwise, we might start retrieving
      // older and older records indefinitely (and we're all about *new*
      // records!)
      const newLowerTimestamp = Math.max(
        lowerTimestamp,
        Date.parse(itemsToProcess[0].created_at),
      );

      // If the total contact count is less than 100, it means that during the
      // next iteration the search results count will most likely be less than
      // 50. In that case, if we extend the upper bound of the search time range
      // we might be able to retrieve more records.
      const newUpperTimestamp = contactCount < 100
        ? eventTimestamp
        : upperTimestamp;

      // The list of processed items can grow indefinitely.
      // Since we don't want to keep track of every processed record
      // ever, we need to clean up this list, removing any records
      // that are no longer relevant.
      const newProcessedItems = this._cleanupOldProcessedItems(
        [
          ...processedItems,
          ...itemsToProcess,
        ],
        newLowerTimestamp,
      );

      // Update the state of the component to reflect the computations
      // made above.
      const newState = {
        processedItems: newProcessedItems,
        lowerTimestamp: newLowerTimestamp,
        upperTimestamp: newUpperTimestamp,
      };
      this.db.set("state", newState);
    },
  },
};

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.
	`timer`	`$.interface.timer`

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#

Generate PDF on HTML 2 PDF

Description:Creates a PDF from a URL or HTML string. [See the documentation](https://www.html2pdf.co.uk/api-documentation)

Version:0.0.1

Key:html_2_pdf-generate-pdf

View on GitHub

HTML 2 PDF Overview#

The HTML 2 PDF API allows you to convert HTML documents to PDFs. In Pipedream, you can integrate this API into workflows to automate document generation tasks. This can be incredibly useful for generating reports, invoices, or any other document where you start with HTML and need a PDF output. You can trigger these conversions with various events – like a new form submission, a scheduled trigger, or even updates in a database.

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import fs from "fs";
import {
  PAGE_SIZE_OPTIONS, UNIT_OPTIONS,
} from "../../common/constants.mjs";
import html2Pdf from "../../html_2_pdf.app.mjs";

export default {
  key: "html_2_pdf-generate-pdf",
  name: "Generate PDF",
  description: "Creates a PDF from a URL or HTML string. [See the documentation](https://www.html2pdf.co.uk/api-documentation)",
  version: "0.0.1",
  type: "action",
  props: {
    html2Pdf,
    url: {
      type: "string",
      label: "URL",
      description: "The URL you want to convert to PDF.",
      optional: true,
    },
    html: {
      type: "string",
      label: "HTML",
      description: "The HTML you want to convert to PDF.",
      optional: true,
    },
    header: {
      type: "string",
      label: "Header",
      description: "Header in HTML format.",
      optional: true,
    },
    footer: {
      type: "string",
      label: "Footer",
      description: "Footer in HTML format.",
      optional: true,
    },
    pageOffset: {
      type: "integer",
      label: "Page Offset",
      description: "Number to offset your page number",
      optional: true,
    },
    pageSize: {
      type: "string",
      label: "Page Size",
      description: "The standard page formats.",
      optional: true,
      options: PAGE_SIZE_OPTIONS,
    },
    orientation: {
      type: "string",
      label: "Orientation",
      description: "The page orientation.",
      optional: true,
      options: [
        "portrait",
        "landscape",
      ],
    },
    width: {
      type: "string",
      label: "Width",
      description: "Custom width (overrides 'Page Size').",
      optional: true,
    },
    height: {
      type: "string",
      label: "Height",
      description: "Custom height (overrides 'Page Size').",
      optional: true,
    },
    top: {
      type: "string",
      label: "Top Margin",
      description: "You need one if you want to display a header.",
      optional: true,
    },
    bottom: {
      type: "string",
      label: "Bottom Margin",
      description: "You need one if you want to display a footer.",
      optional: true,
    },
    left: {
      type: "string",
      label: "Left",
      description: "Left margin.",
      optional: true,
    },
    right: {
      type: "string",
      label: "Right",
      description: "Right margin.",
      optional: true,
    },
    unit: {
      type: "string",
      label: "Unit",
      description: "Unit for the custom width, height and margins.",
      optional: true,
      options: UNIT_OPTIONS,
    },
    cssMediaType: {
      type: "string",
      label: "CSS Media Type",
      description: "The layout CSS media type.",
      options: [
        "print",
        "screen",
      ],
      optional: true,
    },
    optimizeLayout: {
      type: "boolean",
      label: "Optimize Layout",
      description: "Set this to **true** if you want us to auto-optimize your layout. This helps static items on your page to only show up once, instead of on every page.",
      optional: true,
    },
    lazyLoad: {
      type: "boolean",
      label: "Lazy Load",
      description: "Set this to **true** if you want our software to wait for content to lazy load.",
      optional: true,
    },
    waitTime: {
      type: "integer",
      label: "Wait Time",
      description: "**Time in milliseconds** that you want our software to wait after the page is loaded. You typically use this when you have long running JavaScript for graphs and tables.",
      optional: true,
    },
    css: {
      type: "string",
      label: "CSS",
      description: "Use custom CSS to overwrite the default styles of your page.",
      optional: true,
    },
  },
  async run({ $ }) {
    if ((!this.url && !this.html) || (this.url && this.html)) {
      throw new ConfigurationError("You must provide either URL or HTML.");
    }
    const response = await this.html2Pdf.createPdf({
      $,
      responseType: "arraybuffer",
      params: {
        url: this.url,
        html: this.html,
        header: this.header,
        footer: this.footer,
        page_offset: this.pageOffset,
        page_size: this.pageSize,
        orientation: this.orientation,
        width: this.width,
        height: this.height,
        top: this.top,
        bottom: this.bottom,
        left: this.left,
        right: this.right,
        unit: this.unit,
        css_media_type: this.cssMediaType,
        optimize_layout: this.optimizeLayout,
        lazy_load: this.lazyLoad,
        wait_time: this.waitTime,
        css: this.css,
      },
    });

    const filePath = `/tmp/${Date.now()}.pdf`;
    fs.writeFileSync(filePath, response);

    $.export("$summary", "Generated PDF is saved at");
    $.export("file_path", filePath);
    return filePath;
  },
};

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
HTML 2 PDF	`html2Pdf`	`app`	This component uses the HTML 2 PDF app.
URL	`url`	`string`	The URL you want to convert to PDF.
HTML	`html`	`string`	The HTML you want to convert to PDF.
Header	`header`	`string`	Header in HTML format.
Footer	`footer`	`string`	Footer in HTML format.
Page Offset	`pageOffset`	`integer`	Number to offset your page number
Page Size	`pageSize`	`string`	Select a value from the drop down menu:`{ "value": "A0", "label": "A0 - 841 x 1189 mm, 33.1 x 46.8 in" }{ "value": "A1", "label": "A1 - 594 x 841 mm, 23.4 x 33.1 in" }{ "value": "A2", "label": "A2 - 420 x 594 mm, 16.5 x 23.4 in" }{ "value": "A3", "label": "A3 - 297 x 420 mm, 11.7 x 16.5 in" }{ "value": "A4", "label": "A4 - 210 x 297 mm, 8.3 x 11.7 in" }{ "value": "A5", "label": "A5 - 148 x 210 mm, 5.8 x 8.3 in" }{ "value": "A6", "label": "A6 - 105 x 148 mm, 4.1 x 5.8 in" }{ "value": "A7", "label": "A7 - 74 x 105 mm, 2.9 x 4.1 in" }{ "value": "A8", "label": "A8 - 52 x 74 mm, 2.1 x 2.9 in" }{ "value": "A9", "label": "A9 - 37 x 52 mm, 1.5 x 2.1 in" }{ "value": "B0", "label": "B0 - 1000 x 1414 mm, 39.4 x 55.7 in" }{ "value": "B1", "label": "B1 - 707 x 1000 mm, 27.8 x 39.4 in" }{ "value": "B2", "label": "B2 - 500 x 707 mm, 19.7 x 27.8 in" }{ "value": "B3", "label": "B3 - 353 x 500 mm, 13.9 x 19.7 in" }{ "value": "B4", "label": "B4 - 250 x 353 mm, 9.8 x 13.9 in" }{ "value": "B5", "label": "B5 - 176 x 250 mm, 6.9 x 9.8 in" }{ "value": "B6", "label": "B6 - 125 x 176 mm, 4.9 x 6.9 in" }{ "value": "B7", "label": "B7 - 88 x 125 mm, 3.5 x 4.9 in" }{ "value": "B8", "label": "B8 - 62 x 88 mm, 2.4 x 3.5 in" }{ "value": "B9", "label": "B9 - 44 x 62 mm, 1.7 x 2.4 in" }{ "value": "B10", "label": "B10 - 31 x 44 mm, 1.2 x 1.7 in" }{ "value": "C5E", "label": "C5E - 163 x 229 mm" }{ "value": "Comm10E", "label": "Comm10E - 105 x 241 mm, U.S. Common 10 Envelope" }{ "value": "DLE", "label": "DLE - 110 x 220 mm" }{ "value": "Executive", "label": "Executive - 7.25 x 10.5 in" }{ "value": "Folio", "label": "Folio - 210 x 330 mm" }{ "value": "Ledger", "label": "Ledger - 17 x 11 in" }{ "value": "Legal", "label": "Legal - 8.5 x 14.0 in" }{ "value": "Letter", "label": "Letter - 8.5 x 11.0 in" }{ "value": "Tabloid", "label": "Tabloid - 11 x 17 in" }`
Orientation	`orientation`	`string`	Select a value from the drop down menu:`portraitlandscape`
Width	`width`	`string`	Custom width (overrides 'Page Size').
Height	`height`	`string`	Custom height (overrides 'Page Size').
Top Margin	`top`	`string`	You need one if you want to display a header.
Bottom Margin	`bottom`	`string`	You need one if you want to display a footer.
Left	`left`	`string`	Left margin.
Right	`right`	`string`	Right margin.
Unit	`unit`	`string`	Select a value from the drop down menu:`{ "label": "Millimeters (Default)", "value": "mm" }{ "label": "Centimeters", "value": "cm" }{ "label": "Inches", "value": "in" }{ "label": "Pixels", "value": "px" }`
CSS Media Type	`cssMediaType`	`string`	Select a value from the drop down menu:`printscreen`
Optimize Layout	`optimizeLayout`	`boolean`	Set this to true if you want us to auto-optimize your layout. This helps static items on your page to only show up once, instead of on every page.
Lazy Load	`lazyLoad`	`boolean`	Set this to true if you want our software to wait for content to lazy load.
Wait Time	`waitTime`	`integer`	Time in milliseconds that you want our software to wait after the page is loaded. You typically use this when you have long running JavaScript for graphs and tables.
CSS	`css`	`string`	Use custom CSS to overwrite the default styles of your page.