Create a PDF with APITemplate.io API on New Comment (Instant) from Google Sheets API

Pipedream makes it easy to connect APIs for APITemplate.io, Google Sheets and 2,200+ other apps remarkably fast.

Trigger workflow on

New Comment (Instant) from the Google Sheets API

Next, do this

Create a PDF with the APITemplate.io 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 Google Sheets trigger and APITemplate.io action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Comment (Instant) trigger
1. Connect your Google Sheets account
2. Configure Push notification renewal schedule
3. Select a Spreadsheet
Configure the Create a PDF action
1. Connect your APITemplate.io account
2. Optional- Select a API Endpoints
3. Select a Template Id
4. Configure Data
5. Optional- Configure Expiration
6. Optional- Configure Meta
7. Optional- Select a Export Type
8. Optional- Configure Output HTML
9. Optional- Select a Output Format
10. Optional- Configure Filename
11. Optional- Configure Image Resample Res
12. Optional- Configure Is CMYK
13. Optional- Configure Async
14. Optional- Configure Webhook URL
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 Comment (Instant) on Google Sheets

Description:Emit new event each time a comment is added to a spreadsheet.

Version:0.0.3

Key:google_sheets-new-comment

View on GitHub

Google Sheets Overview#

The Google Sheets API allows for the creation, reading, updating, and deletion of data within Google Sheets, enabling a robust platform for spreadsheet management and data manipulation. Through Pipedream, you can craft serverless workflows that respond to various triggers, such as webhook events, emails, or scheduled times, to interact with Google Sheets. This synergy can automate reporting, synchronize data across applications, manage inventory, track leads in a CRM, or even conduct survey analysis by updating and retrieving sheet data on the fly.

Trigger Code#

import httpBase from "../common/http-based/sheet.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...httpBase,
  key: "google_sheets-new-comment",
  name: "New Comment (Instant)",
  description: "Emit new event each time a comment is added to a spreadsheet.",
  version: "0.0.3",
  dedupe: "unique",
  type: "source",
  methods: {
    ...httpBase.methods,
    _getLastTs() {
      return this.db.get("lastTs");
    },
    _setLastTs(lastTs) {
      this.db.set("lastTs", lastTs);
    },
    generateMeta(comment) {
      return {
        id: comment.id,
        summary: `New Comment: ${comment.content}`,
        ts: Date.parse(comment.createdTime),
      };
    },
    takeSheetSnapshot() {},
    getSheetId() {
      return this.sheetID.toString();
    },
    async processSpreadsheet() {
      const comments = [];
      const lastTs = this._getLastTs();
      const results = this.googleSheets.listComments(this.sheetID, lastTs);
      for await (const comment of results) {
        comments.push(comment);
      }
      if (!comments.length) {
        return;
      }
      this._setLastTs(comments[0].createdTime);
      comments.reverse().forEach((comment) => {
        const meta = this.generateMeta(comment);
        this.$emit(comment, meta);
      });
    },
  },
  async run(event) {
    if (event.timestamp) {
      // Component was invoked by timer
      return this.renewSubscription();
    }

    if (!this.isEventRelevant(event)) {
      console.log("Sync notification, exiting early");
      return;
    }

    await this.processSpreadsheet();
  },
  sampleEmit,
};

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
Google Sheets	`googleSheets`	`app`	This component uses the Google Sheets app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
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.
Push notification renewal schedule	`timer`	`$.interface.timer`	The Google Drive API requires occasionally renewal of push notification subscriptions. This runs in the background, so you should not need to modify this schedule.
Spreadsheet	`sheetID`	`string`	Select a value from the drop down menu.

Trigger Authentication#

Google Sheets uses OAuth authentication. When you connect your Google Sheets account, Pipedream will open a popup window where you can sign into Google Sheets and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Google Sheets API.

Pipedream requests the following authorization scopes when you connect your account:

emailprofilehttps://www.googleapis.com/auth/drive

About Google Sheets#

Use Google Sheets to create and edit online spreadsheets. Get insights together with secure sharing in real-time and from any device.

Action#

Create a PDF on APITemplate.io

Description:Create a PDF file with JSON data and your template. [See the docs](https://apitemplate.io/apiv2/#tag/API-Integration/operation/create-pdf) for more information

Version:0.0.1

Key:apitemplate_io-create-pdf

View on GitHub

APITemplate.io Overview#

APITemplate.io's API unleashes creative automation for generating images or PDFs from predefined templates. It's a powerful tool for creating custom visual content on-the-fly, ideal for marketers, developers, or content creators who need to personalize images or documents at scale. With Pipedream's integration capabilities, you can construct workflows that trigger custom media creation based on specific triggers or actions from a wide range of apps and services.

Action Code#

import app from "../../app/apitemplate_io.app.mjs";
import { defineAction } from "@pipedream/types";
export default defineAction({
    name: "Create a PDF",
    description: "Create a PDF file with JSON data and your template. [See the docs](https://apitemplate.io/apiv2/#tag/API-Integration/operation/create-pdf) for more information",
    key: "apitemplate_io-create-pdf",
    version: "0.0.1",
    type: "action",
    props: {
        app,
        apiEndpoints: {
            propDefinition: [
                app,
                "apiEndpoints",
            ],
        },
        templateId: {
            propDefinition: [
                app,
                "templateId",
                () => ({
                    format: "PDF",
                }),
            ],
        },
        data: {
            propDefinition: [
                app,
                "data",
            ],
        },
        expiration: {
            propDefinition: [
                app,
                "expiration",
            ],
        },
        meta: {
            propDefinition: [
                app,
                "meta",
            ],
        },
        exportType: {
            propDefinition: [
                app,
                "exportType",
            ],
        },
        outputHtml: {
            propDefinition: [
                app,
                "outputHtml",
            ],
        },
        outputFormat: {
            propDefinition: [
                app,
                "outputFormat",
            ],
        },
        filename: {
            propDefinition: [
                app,
                "filename",
            ],
        },
        imageResampleRes: {
            propDefinition: [
                app,
                "imageResampleRes",
            ],
        },
        isCmyk: {
            propDefinition: [
                app,
                "isCmyk",
            ],
        },
        async: {
            propDefinition: [
                app,
                "async",
            ],
        },
        webhookUrl: {
            propDefinition: [
                app,
                "webhookUrl",
            ],
        },
    },
    methods: {
        boolToInt(prop) {
            if (typeof (prop) === "boolean") {
                if (prop) {
                    return 1;
                }
                return 0;
            }
            return prop;
        },
    },
    async run({ $ }) {
        const params = {
            template_id: this.templateId,
            expiration: this.expiration,
            meta: this.meta,
            export_type: this.exportType,
            output_html: this.boolToInt(this.outputHtml),
            output_format: this.outputFormat,
            filename: this.filename,
            image_resample_res: this.imageResampleRes,
            is_cmyk: this.boolToInt(this.isCmyk),
            async: this.boolToInt(this.async),
            webhook_url: this.webhookUrl,
        };
        const response = await this.app.createImage($, this.apiEndpoints, params, this.data);
        $.export("$summary", `Successfully created a new PDF: ${response.transaction_ref}`);
        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
APITemplate.io	`app`	`app`	This component uses the APITemplate.io app.
API Endpoints	`apiEndpoints`	`string`	Select a value from the drop down menu:`{ "label": "Default (Singapore)", "value": "https://rest.apitemplate.io" }{ "label": "Europe (Frankfurt)", "value": "https://rest-de.apitemplate.io" }{ "label": "US East (N. Virginia)", "value": "https://rest-us.apitemplate.io" }{ "label": "Australia (Sydney)", "value": "https://rest-au.apitemplate.io" }{ "label": "Alternative Default (Singapore)", "value": "https://rest-alt.apitemplate.io" }{ "label": "Alternative Europe (Frankfurt)", "value": "https://rest-alt-de.apitemplate.io" }{ "label": "Alternative US East (N. Virginia)", "value": "https://rest-alt-us.apitemplate.io" }`
Template Id	`templateId`	`string`	Select a value from the drop down menu.
Data	`data`	`any`	Object to replace values on the template, you can check here for the JSON example for your template.
Expiration	`expiration`	`integer`	Expiration of the generated image in minutes(default to `0`, store permanently).
Meta	`meta`	`string`	Specify an external reference ID for your own reference. It appears in the `list-objects` API.
Export Type	`exportType`	`string`	Select a value from the drop down menu:`jsonfile`
Output HTML	`outputHtml`	`boolean`	Whether it should output html or not
Output Format	`outputFormat`	`string`	Select a value from the drop down menu:`pdfhtml`
Filename	`filename`	`string`	Default to UUID (e.g 0c93bd9e-9ebb-4634-a70f-de9131848416.pdf). Use this to specify custom file name, it should end with `.pdf`
Image Resample Res	`imageResampleRes`	`integer`	We embed the original images by default, meaning large PDF file sizes. Specifying this option helps reduce the PDF file size. Common values are `72`, `96`, `150`, `300` and `600`.
Is CMYK	`isCmyk`	`boolean`	Use CMYK color profile, Default to `false`
Async	`async`	`boolean`	To generate PDF asynchronously, set the value to `true` and the API call returns immediately. Once the PDF document is generated, we will make a HTTP/HTTPS GET to your webhook and will retry for 3 times before giving up.
Webhook URL	`webhookUrl`	`string`	It is the URL of your webhook URL, it starts with `http://` or `https://` and has to be urlencoded.

Action Authentication#

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

To retrieve your API key,