← Google Sheets

New Worksheet (Instant) from Google Sheets API

Pipedream makes it easy to connect APIs for Google Sheets and + other apps remarkably fast.

Trigger workflow on
New Worksheet (Instant) from the Google Sheets API
Next, do this
Connect to 600+ APIs using code and no-code building blocks
No credit card required
Trusted by 200,000+ developers from startups to Fortune 500 companies:
Trusted by 200,000+ developers from startups to Fortune 500 companies

Developers Pipedream

Getting Started

Trigger a workflow on New Worksheet (Instant) with Google Sheets API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the New Worksheet (Instant) trigger
    1. Connect your Google Sheets account
    2. Configure Push notification renewal schedule
    3. Select a Drive
    4. Select a Spreadsheet
  2. Add steps to connect to + APIs using code and no-code building blocks
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger


This is a pre-built, open source 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.

New Worksheet (Instant) on Google Sheets
Description:Emit new event each time a new worksheet is created in a spreadsheet.


import common from "../common.mjs";

export default {
  key: "google_sheets-new-worksheet",
  type: "source",
  name: "New Worksheet (Instant)",
    "Emit new event each time a new worksheet is created in a spreadsheet.",
  version: "0.0.9",
  dedupe: "unique",
  props: {
    sheetID: {
      propDefinition: [
        (c) => ({
          driveId: common.methods.getDriveId(c.watchedDrive),
  hooks: {
    async deploy() {
      await this.processSpreadsheet({
        spreadsheetId: this.sheetID,
  methods: {
    generateMeta(worksheet) {
      return {
        id: worksheet.properties.sheetId,
        summary: worksheet.properties.title,
        ts: Date.now(),
     * Temporary transformation to ensure the format of the data is the
     * correct one. This will be fixed in the UI and backend, so that the data
     * format is guaranteed to be the one indicated in the `type` field of the
     * user prop.
    getSheetId() {
      return this.sheetID.toString();
    _getWorksheetIds() {
      return this.db.get("worksheetIds");
    _setWorksheetIds(worksheetIds) {
      this.db.set("worksheetIds", worksheetIds);
    async processSpreadsheet({ spreadsheetId }) {
      const { sheets: worksheets } = await this.googleSheets.getSpreadsheet(
      let worksheetIds = this._getWorksheetIds() || [];
      for (const worksheet of worksheets) {
        if (worksheetIds.includes(worksheet.properties.sheetId)) continue;
        const meta = this.generateMeta(worksheet);
        this.$emit(worksheet, meta);
    takeSheetSnapshot() {},


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.
Google SheetsgoogleSheetsappThis component uses the Google Sheets app.
N/Adb$.service.dbThis component uses $.service.db to maintain state between component invocations.
N/Ahttp$.interface.httpThis 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 scheduletimer$.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.

DrivewatchedDrivestringSelect a value from the drop down menu.
SpreadsheetsheetIDstringSelect a value from the drop down menu.


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:


About Google Sheets

With Google Sheets, you can create, edit, and collaborate wherever you are

About Pipedream

Stop writing boilerplate code, struggling with authentication and managing infrastructure. Start connecting APIs with code-level control when you need it — and no code when you don't.

Into to Pipedream
Watch us build a workflow
Watch us build a workflow
4 min
Watch now ➜
"The past few weeks, I truly feel like the clichéd 10x engineer."
Powerful features that scale
Manage concurrency and execution rate
Manage concurrency and execution rate

Queue up to 10,000 events per workfow and manage the concurrency and rate at which workflows are triggered.

Process large payloads up to 5 terabytes
Process large payloads up to 5 terabytes

Large file support enables you to trigger workflows with any data (e.g., large JSON files, images and videos) up to 5 terabytes.

Return custom responses to HTTP requests
Return custom responses to HTTP requests

Return any JSON-serializable response from an HTTP triggered workflow using $respond().

Use most npm packages
Use most npm packages

To use any npm package, just require() it -- there's no npm install or package.json required.

Maintain state between executions
Maintain state between executions

Use $checkpoint to save state in one workflow invocation and read it the next time your workflow runs.

Pass data between steps
Pass data between steps

Return data from any step to inspect it in a human-friendly way and reference the data in future steps via the steps object.