Add Single Row with Google Sheets API on New Contact Property Change from VBOUT API

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

Trigger workflow on

New Contact Property Change from the VBOUT API

Next, do this

Add Single Row with the Google Sheets 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 VBOUT trigger and Google Sheets 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 Property Change trigger
1. Connect your VBOUT account
2. Configure Polling interval
3. Select a List
4. Select a Contact
Configure the Add Single Row action
1. Connect your Google Sheets account
2. Optional- Select a Drive
3. Select a Spreadsheet
4. Select one or more Worksheet(s)
5. Configure Does the first row of the sheet have headers?
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 Property Change on VBOUT

Description:Emit new event for each new property changed in a specific contact. [See docs here](https://developers.vbout.com/docs#emailmarketing_getcontact)

Version:0.0.3

Key:vbout-new-contact-property-change

View on GitHub

VBOUT Overview#

The VBOUT API unlocks the potential to automate your marketing stack, leveraging Pipedream's capabilities for seamless integrations with other services. With VBOUT, you can manage contacts, automate email campaigns, track user actions, and analyze performance data. Pipedream enhances this by allowing you to capture events in real-time, process data with serverless code, and connect with countless apps to extend your marketing automation workflows.

Trigger Code#

import vbout from "../../vbout.app.mjs";
import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";

export default {
  type: "source",
  name: "New Contact Property Change",
  key: "vbout-new-contact-property-change",
  description: "Emit new event for each new property changed in a specific contact. [See docs here](https://developers.vbout.com/docs#emailmarketing_getcontact)",
  version: "0.0.3",
  props: {
    vbout,
    db: "$.service.db",
    timer: {
      label: "Polling interval",
      description: "Pipedream will poll the vbout API on this schedule",
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    list: {
      propDefinition: [
        vbout,
        "list",
      ],
      reloadProps: true,
      description: "Select the list to load contacts",
    },
    contact: {
      propDefinition: [
        vbout,
        "contact",
        (c) => ({
          listId: c.list.value,
        }),
      ],
    },
  },
  methods: {
    _getLastObject() {
      return this.db.get("lastObject");
    },
    _setLastObject(lastObject) {
      this.db.set("lastObject", lastObject);
    },
    getDataToEmit({
      id, email,
    }) {
      const ts = new Date().getTime();
      return {
        id,
        summary: `New property changed from contact (${email})`,
        ts,
      };
    },
  },
  async run() {
    const lastObject = this._getLastObject();
    const { contact } = await this.vbout.getContact({
      id: this.contact.value,
    });

    if (lastObject !== JSON.stringify(contact)) {
      this._setLastObject(JSON.stringify(contact));
      this.$emit(contact, this.getDataToEmit(contact));
    }
  },
};

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
VBOUT	`vbout`	`app`	This component uses the VBOUT app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Polling interval	`timer`	`$.interface.timer`	Pipedream will poll the vbout API on this schedule
List	`list`	`string`	Select a value from the drop down menu.
Contact	`contact`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

To retrieve your API key,

Navigate to your VBOUT account and sign in
Go to “Settings” > “API Integrations”

About VBOUT#

VBOUT offers several marketing tools into one powerful platform: Social media, landing pages, lead management, email marketing, automation and analytics.

Action#

Add Single Row on Google Sheets

Description:Add a single row of data to Google Sheets. [See the documentation](https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets.values/append)

Version:2.1.11

Key:google_sheets-add-single-row

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.

Action Code#

import common from "../common/worksheet.mjs";
import { ConfigurationError } from "@pipedream/platform";
import { parseArray } from "../../common/utils.mjs";
import { isDynamicExpression } from "../common/worksheet.mjs";

const { googleSheets } = common.props;

export default {
  ...common,
  key: "google_sheets-add-single-row",
  name: "Add Single Row",
  description: "Add a single row of data to Google Sheets. [See the documentation](https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets.values/append)",
  version: "2.1.11",
  type: "action",
  props: {
    googleSheets,
    drive: {
      propDefinition: [
        googleSheets,
        "watchedDrive",
      ],
    },
    sheetId: {
      propDefinition: [
        googleSheets,
        "sheetID",
        (c) => ({
          driveId: googleSheets.methods.getDriveId(c.drive),
        }),
      ],
      reloadProps: true,
    },
    worksheetId: {
      propDefinition: [
        googleSheets,
        "worksheetIDs",
        (c) => ({
          sheetId: c.sheetId?.value || c.sheetId,
        }),
      ],
      description: "Select a worksheet or enter a custom expression. When referencing a spreadsheet dynamically, you must provide a custom expression for the worksheet.",
      async options({ sheetId }) {
        // If sheetId is a dynamic reference, don't load options
        if (isDynamicExpression(sheetId)) {
          return [];
        }

        // Otherwise, call the original options function with the correct context
        const origOptions = googleSheets.propDefinitions.worksheetIDs.options;
        return origOptions.call(this, {
          sheetId,
        });
      },
      reloadProps: true,
    },
    hasHeaders: common.props.hasHeaders,
  },
  async additionalProps() {
    const {
      sheetId,
      worksheetId,
      hasHeaders,
    } = this;

    // If using dynamic expressions for either sheetId or worksheetId, return only array input
    if (isDynamicExpression(sheetId) || isDynamicExpression(worksheetId)) {
      return {
        myColumnData: {
          type: "string[]",
          label: "Values",
          description: "Provide a value for each cell of the row. Google Sheets accepts strings, numbers and boolean values for each cell. To set a cell to an empty value, pass an empty string.",
        },
      };
    }

    const props = {};
    if (hasHeaders) {
      try {
        const worksheet = await this.getWorksheetById(sheetId, worksheetId);
        const { values } = await this.googleSheets.getSpreadsheetValues(sheetId, `${worksheet?.properties?.title}!1:1`);

        if (!values?.[0]?.length) {
          throw new ConfigurationError("Could not find a header row. Please either add headers and click \"Refresh fields\" or set 'Does the first row of the sheet have headers?' to false.");
        }

        for (let i = 0; i < values[0]?.length; i++) {
          props[`col_${i.toString().padStart(4, "0")}`] = {
            type: "string",
            label: values[0][i],
            optional: true,
          };
        }
        props.allColumns = {
          type: "string",
          hidden: true,
          default: JSON.stringify(values),
        };
      } catch (err) {
        console.error("Error fetching headers:", err);
        // Fallback to basic column input if headers can't be fetched
        return {
          headerError: {
            type: "string",
            label: "Header Fetch Error",
            description: `Unable to fetch headers: ${err.message}. Using simple column input instead.`,
            optional: true,
            hidden: true,
          },
          myColumnData: {
            type: "string[]",
            label: "Values",
            description: "Provide a value for each cell of the row. Google Sheets accepts strings, numbers and boolean values for each cell. To set a cell to an empty value, pass an empty string.",
          },
        };
      }
    } else {
      props.myColumnData = {
        type: "string[]",
        label: "Values",
        description: "Provide a value for each cell of the row. Google Sheets accepts strings, numbers and boolean values for each cell. To set a cell to an empty value, pass an empty string.",
      };
    }
    return props;
  },
  async run({ $ }) {
    const {
      sheetId,
      worksheetId,
    } = this;

    const { name: sheetName } = await this.googleSheets.getFile(sheetId, {
      fields: "name",
    });

    const worksheet = await this.getWorksheetById(sheetId, worksheetId);

    let cells;
    if (this.hasHeaders
      && !isDynamicExpression(sheetId)
      && !isDynamicExpression(worksheetId)
      && this.allColumns
    ) {
      const rows = JSON.parse(this.allColumns);
      const [
        headers,
      ] = rows;
      cells = headers
        .map((_, i) => `col_${i.toString().padStart(4, "0")}`)
        .map((column) => this[column] ?? "");
    } else {
      // For dynamic references or no headers, use the array input
      cells = this.googleSheets.sanitizedArray(this.myColumnData);
    }

    // Validate input
    if (!cells || !cells.length) {
      throw new ConfigurationError("Please enter an array of elements in `Cells / Column Values`.");
    }
    cells = parseArray(cells);
    if (!cells) {
      throw new ConfigurationError("Cell / Column data is not an array. Please enter an array of elements in `Cells / Column Values`.");
    } else if (Array.isArray(cells[0])) {
      throw new ConfigurationError("Cell / Column data is a multi-dimensional array. A one-dimensional is expected. If you're trying to send multiple rows to Google Sheets, search for the action to add multiple rows to Sheets.");
    }

    const {
      arr: sanitizedCells,
      convertedIndexes,
    } = this.googleSheets.arrayValuesToString(cells);

    const data = await this.googleSheets.addRowsToSheet({
      spreadsheetId: sheetId,
      range: worksheet?.properties?.title,
      rows: [
        sanitizedCells,
      ],
    });

    let summary = `Added 1 row to [${sheetName || sheetId} (${data.updatedRange})](https://docs.google.com/spreadsheets/d/${sheetId}).`;
    if (convertedIndexes.length > 0) {
      summary += " We detected something other than a string/number/boolean in at least one of the fields and automatically converted it to a string.";
    }
    $.export("$summary", summary);

    return data;
  },
};

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
Google Sheets	`googleSheets`	`app`	This component uses the Google Sheets app.
Drive	`drive`	`string`	Select a value from the drop down menu.
Spreadsheet	`sheetId`	`string`	Select a value from the drop down menu.
Worksheet(s)	`worksheetId`	`string[]`	Select a value from the drop down menu.
Does the first row of the sheet have headers?	`hasHeaders`	`boolean`	If the first row of your document has headers, we'll retrieve them to make it easy to enter the value for each column. Note: When using a dynamic reference for the worksheet ID (e.g. `{{steps.foo.$return_value}}`), this setting is ignored.

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

More Ways to Connect Google Sheets + VBOUT#

Other Popular Integrations#

Add Contact To List By Email with VBOUT API on New Updates (Shared Drive, Instant) from Google Sheets API

Google Sheets + VBOUT

Add Single Row with Google Sheets API on New Contact Property Change from VBOUT API

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

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

Developers ♥ Pipedream

1-24of2,400+apps by most popular

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