Add Conditional Format Rule with Google Sheets API on New Lead Created from Vtiger CRM API

Pipedream makes it easy to connect APIs for Google Sheets, Vtiger CRM and 3,000+ other apps remarkably fast.

Trigger workflow on

New Lead Created from the Vtiger CRM API

Next, do this

Add Conditional Format Rule 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 Vtiger CRM 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 Lead Created trigger
1. Connect your Vtiger CRM account
2. Configure timer
Configure the Add Conditional Format Rule action
1. Connect your Google Sheets account
2. Optional- Select a Drive
3. Select a Spreadsheet ID
4. Select a Worksheet ID
5. Configure Range
6. Select a Validation Type
7. Configure Condition Values
8. Select a Formatting Type
9. Optional- Configure RGB Color
10. Optional- Configure Text Format
11. Optional- Configure Bold
12. Optional- Configure Italic
13. Optional- Configure Strikethrough
14. Optional- Select a Interpolation Point Type
15. Configure Index
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 Lead Created on Vtiger CRM

Description:Emit new event when a new lead is created in VTiger CRM.

Version:0.0.1

Key:vtiger_crm-new-lead-created

View on GitHub

Vtiger CRM Overview#

The Vtiger CRM API lets you tap into your customer relationship data to create, read, update, and delete records across various entities such as contacts, leads, and opportunities. In Pipedream, you can leverage this API to automate workflows, sync data across platforms, and react to events in real-time, all without the need for dedicated backend code. You can create dynamic workflows that respond to webhooks, schedule tasks, and integrate with 3,000+ apps readily available on Pipedream.

Trigger Code#

import base from "../common/base.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...base,
  key: "vtiger_crm-new-lead-created",
  name: "New Lead Created",
  description: "Emit new event when a new lead is created in VTiger CRM.",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  methods: {
    ...base.methods,
    async getResources(modifiedTime) {
      const { result: { updated: leads } } = await this.vtiger.getSync({
        params: {
          modifiedTime,
          elementType: "Leads",
          syncType: "user",
        },
      });
      return leads;
    },
    getTsField() {
      return "createdtime";
    },
    generateMeta(lead) {
      return {
        id: lead.id,
        summary: `New Lead with ID ${lead.id}`,
        ts: Date.parse(lead.createdtime),
      };
    },
  },
  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
Vtiger CRM	`vtiger`	`app`	This component uses the Vtiger CRM app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`

Trigger Authentication#

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

To retrieve your Access Key,

Navigate to your Vtiger CRM account and sign in
Click the dropdown on the to right
Go to “My Preferences”

Your instance is 1234.abc if your Vtiger CRM dashboard URL is https://1234.abc.vtiger.com/
Enter the email address you use to log into VTiger CRM as the username

About Vtiger CRM#

Vtiger all-in-one CRM empowers you to align your marketing, sales and support teams with unified customer data powered by One View

Action#

Add Conditional Format Rule on Google Sheets

Description:Create conditional formatting with color scales or custom formulas. [See the documentation](https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/request#AddConditionalFormatRuleRequest)

Version:0.0.1

Key:google_sheets-add-conditional-format-rule

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 googleSheets from "../../google_sheets.app.mjs";
import { ConfigurationError } from "@pipedream/platform";

export default {
  key: "google_sheets-add-conditional-format-rule",
  name: "Add Conditional Format Rule",
  description: "Create conditional formatting with color scales or custom formulas. [See the documentation](https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/request#AddConditionalFormatRuleRequest)",
  version: "0.0.1",
  type: "action",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  props: {
    googleSheets,
    drive: {
      propDefinition: [
        googleSheets,
        "watchedDrive",
      ],
    },
    sheetId: {
      propDefinition: [
        googleSheets,
        "sheetID",
        (c) => ({
          driveId: googleSheets.methods.getDriveId(c.drive),
        }),
      ],
    },
    worksheetId: {
      propDefinition: [
        googleSheets,
        "worksheetIDs",
        (c) => ({
          sheetId: c.sheetId,
        }),
      ],
    },
    range: {
      propDefinition: [
        googleSheets,
        "range",
      ],
      description: "The range of cells to format (e.g., `A1:A10`)",
    },
    conditionType: {
      type: "string",
      label: "Validation Type",
      description: "The type of data condition",
      options: [
        "ONE_OF_LIST",
        "NUMBER_GREATER",
        "NUMBER_LESS",
        "DATE_BEFORE",
        "DATE_AFTER",
        "TEXT_CONTAINS",
        "TEXT_IS_EMAIL",
        "TEXT_IS_URL",
        "BOOLEAN",
      ],
    },
    conditionValues: {
      type: "string[]",
      label: "Condition Values",
      description: "Values for condition (e.g., color scales or custom formulas)",
    },
    formattingType: {
      type: "string",
      label: "Formatting Type",
      description: "Choose between boolean condition or gradient color scale",
      options: [
        "BOOLEAN_RULE",
        "GRADIENT_RULE",
      ],
      default: "BOOLEAN_RULE",
    },
    rgbColor: {
      type: "object",
      label: "RGB Color",
      description: "The RGB color value (e.g., {\"red\": 1.0, \"green\": 0.5, \"blue\": 0.2})",
      optional: true,
    },
    textFormat: {
      type: "object",
      label: "Text Format",
      description: "The text format options",
      optional: true,
    },
    bold: {
      type: "boolean",
      label: "Bold",
      description: "Whether the text is bold",
      optional: true,
    },
    italic: {
      type: "boolean",
      label: "Italic",
      description: "Whether the text is italic",
      optional: true,
    },
    strikethrough: {
      type: "boolean",
      label: "Strikethrough",
      description: "Whether the text is strikethrough",
      optional: true,
    },
    interpolationPointType: {
      type: "string",
      label: "Interpolation Point Type",
      description: "The interpolation point type",
      options: [
        "MIN",
        "MAX",
        "NUMBER",
        "PERCENT",
        "PERCENTILE",
      ],
      optional: true,
    },
    index: {
      type: "integer",
      label: "Index",
      description: "The zero-based index of the rule",
    },
  },
  async run({ $ }) {
    const {
      startCol,
      endCol,
      startRow,
      endRow,
    } = this.googleSheets._parseRangeString(`${this.worksheetId}!${this.range}`);

    const rule = {
      ranges: [
        {
          sheetId: this.worksheetId,
          startRowIndex: startRow,
          endRowIndex: endRow,
          startColumnIndex: startCol.charCodeAt(0) - 65,
          endColumnIndex: endCol.charCodeAt(0) - 64,
        },
      ],
    };

    const parseRgbColor = (rgbColor = {}) => {
      if (typeof rgbColor === "string") {
        try {
          rgbColor = JSON.parse(rgbColor);
        } catch {
          throw new ConfigurationError("Could not parse RGB Color. Please provide a valid JSON object.");
        }
      }
      return rgbColor;
    };

    this.formattingType === "GRADIENT_RULE" ?
      rule.gradientRule = {
        minpoint: {
          colorStyle: {
            rgbColor: parseRgbColor(this.rgbColor),
          },
          type: this.interpolationPointType,
          value: "MIN",
        },
        midpoint: {
          colorStyle: {
            rgbColor: parseRgbColor(this.rgbColor),
          },
          type: this.interpolationPointType,
          value: "MID",
        },
        maxpoint: {
          colorStyle: {
            rgbColor: parseRgbColor(this.rgbColor),
          },
          type: this.interpolationPointType,
          value: "MAX",
        },
      } :
      rule.booleanRule = {
        condition: {
          type: this.conditionType,
          values: this.conditionValues?.map((v) => ({
            userEnteredValue: v,
          })) || [],
        },
        format: {
          backgroundColorStyle: {
            rgbColor: parseRgbColor(this.rgbColor),
          },
          textFormat: {
            ...this.textFormat,
            foregroundColorStyle: {
              rgbColor: parseRgbColor(this.rgbColor),
            },
            bold: this.bold,
            italic: this.italic,
            strikethrough: this.strikethrough,
          },
        },
      };

    const request = {
      spreadsheetId: this.sheetId,
      requestBody: {
        requests: [
          {
            addConditionalFormatRule: {
              rule,
              index: this.index,
            },
          },
        ],
      },
    };
    const response = await this.googleSheets.batchUpdate(request);
    $.export("$summary", "Successfully added conditional format rule.");
    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
Google Sheets	`googleSheets`	`app`	This component uses the Google Sheets app.
Drive	`drive`	`string`	Select a value from the drop down menu.
Spreadsheet ID	`sheetId`	`string`	Select a value from the drop down menu.
Worksheet ID	`worksheetId`	`integer`	Select a value from the drop down menu.
Range	`range`	`string`	The range of cells to format (e.g., `A1:A10`)
Validation Type	`conditionType`	`string`	Select a value from the drop down menu:`ONE_OF_LISTNUMBER_GREATERNUMBER_LESSDATE_BEFOREDATE_AFTERTEXT_CONTAINSTEXT_IS_EMAILTEXT_IS_URLBOOLEAN`
Condition Values	`conditionValues`	`string[]`	Values for condition (e.g., color scales or custom formulas)
Formatting Type	`formattingType`	`string`	Select a value from the drop down menu:`BOOLEAN_RULEGRADIENT_RULE`
RGB Color	`rgbColor`	`object`	The RGB color value (e.g., {"red": 1.0, "green": 0.5, "blue": 0.2})
Text Format	`textFormat`	`object`	The text format options
Bold	`bold`	`boolean`	Whether the text is bold
Italic	`italic`	`boolean`	Whether the text is italic
Strikethrough	`strikethrough`	`boolean`	Whether the text is strikethrough
Interpolation Point Type	`interpolationPointType`	`string`	Select a value from the drop down menu:`MINMAXNUMBERPERCENTPERCENTILE`
Index	`index`	`integer`	The zero-based index of the rule

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

Add Conditional Format Rule with Google Sheets API on New Lead Created from Vtiger CRM API

Pipedream makes it easy to connect APIs for Google Sheets, Vtiger CRM and 3,000+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of3,000+apps by most popular

1
-
24
of
3,000+
apps by most popular