List Objects with Zoho CRM API on New Labeled Email from Gmail API

Pipedream makes it easy to connect APIs for Zoho CRM, Gmail and 2,400+ other apps remarkably fast.

Trigger workflow on

New Labeled Email from the Gmail API

Next, do this

List Objects with the Zoho CRM 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 Gmail trigger and Zoho CRM action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Labeled Email trigger
1. Configure timer
2. Connect your Gmail account
3. Select a Label
Configure the List Objects action
1. Connect your Zoho CRM account
2. Select a Module
3. Optional- Configure Fields
4. Optional- Configure IDs
5. Optional- Select a Sort Order
6. Optional- Configure Sort By
7. Optional- Select a Converted
8. Optional- Select a Approved
9. Optional- Configure Page
10. Optional- Configure Per Page
11. Optional- Configure Custom View ID
12. Optional- Configure Territory ID
13. Optional- Configure Include Child
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 Labeled Email on Gmail

Description:Emit new event when a new email is labeled.

Version:0.0.6

Key:gmail-new-labeled-email

View on GitHub

Gmail Overview#

By connecting your personal Gmail account to Pipedream, you'll be able to incorporate email into whatever you're building with any of the thousands of apps that are available on Pipedream.

Trigger Code#

import gmail from "../../gmail.app.mjs";
import common from "../common/polling-history.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...common,
  key: "gmail-new-labeled-email",
  name: "New Labeled Email",
  description: "Emit new event when a new email is labeled.",
  type: "source",
  version: "0.0.6",
  dedupe: "unique",
  props: {
    ...common.props,
    gmail,
    label: {
      propDefinition: [
        gmail,
        "label",
      ],
    },
  },
  methods: {
    ...common.methods,
    getHistoryTypes() {
      return [
        "labelAdded",
        "messageAdded",
      ];
    },
    generateMeta(message) {
      return {
        id: `${message.id}-${this.label}`,
        summary: `A new message with ID: ${message.id} was labeled with "${this.label}"`,
        ts: +message.internalDate,
      };
    },
    filterHistory(history) {
      return history.filter((item) =>
        (item.labelsAdded && item.labelsAdded[0].labelIds.includes(this.label))
        || (item.messagesAdded
          && item.messagesAdded[0].message.labelIds
          && item.messagesAdded[0].message.labelIds.includes(this.label)));
    },
  },
  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
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Gmail	`gmail`	`app`	This component uses the Gmail app.
Label	`label`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

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

emailprofileopenidhttps://www.googleapis.com/auth/gmail.labelshttps://www.googleapis.com/auth/gmail.sendhttps://www.googleapis.com/auth/gmail.modifyhttps://www.googleapis.com/auth/gmail.composehttps://www.googleapis.com/auth/gmail.settings.basic

About Gmail#

Gmail offers private and secure email by Google at no cost, for business and consumer accounts.

Action#

List Objects on Zoho CRM

Description:Gets the list of available records from a module.

Version:0.2.1

Key:zoho_crm-list-objects

View on GitHub

Zoho CRM Overview#

The Zoho CRM API enables the manipulation and retrieval of data within Zoho CRM, a platform for managing your sales, marketing, support, and inventory in a single system. Leveraging this on Pipedream, you can automate tasks like syncing contacts, updating lead statuses, or creating custom CRM operations that trigger actions in other apps. Pipedream's serverless platform allows for real-time data processing, transforming, and orchestrating workflows that respond to events in Zoho CRM with minimal latency.

Action Code#

import zohoCrm from "../../zoho_crm.app.mjs";

export default {
  key: "zoho_crm-list-objects",
  name: "List Objects",
  description: "Gets the list of available records from a module.",
  version: "0.2.1",
  type: "action",
  props: {
    zohoCrm,
    module: {
      propDefinition: [
        zohoCrm,
        "module",
      ],
    },
    fields: {
      type: "string",
      label: "Fields",
      description: "To retrieve specific field values. Comma separated field API names.",
      optional: true,
    },
    ids: {
      type: "string",
      label: "IDs",
      description: "To retrieve specific records based on their unique ID.",
      optional: true,
    },
    sortOrder: {
      type: "string",
      label: "Sort Order",
      description: "To sort the list of records in either ascending or descending order.",
      optional: true,
      options: [
        "asc",
        "desc",
      ],
    },
    sortBy: {
      type: "string",
      label: "Sort By",
      description: "Specify the API name of the field based on which the records must be sorted.",
      optional: true,
    },
    converted: {
      type: "string",
      label: "Converted",
      description: "To retrieve the list of converted records.",
      optional: true,
      options: [
        "false",
        "true",
        "both",
      ],
    },
    approved: {
      type: "string",
      label: "Approved",
      description: "To retrieve the list of approved records.",
      optional: true,
      options: [
        "false",
        "true",
        "both",
      ],
    },
    page: {
      type: "string",
      label: "Page",
      description: "To get the list of records from the respective pages.",
      optional: true,
    },
    perPage: {
      type: "string",
      label: "Per Page",
      description: "To get the list of records available per page.",
      optional: true,
    },
    cvId: {
      type: "string",
      label: "Custom View ID",
      description: "To get the list of records in a custom view.",
      optional: true,
    },
    territoryId: {
      type: "string",
      label: "Territory ID",
      description: "To get the list of records in a territory.",
      optional: true,
    },
    includeChild: {
      type: "boolean",
      label: "Include Child",
      description: "To include records from the child territories",
      optional: true,
    },
  },
  async run({ $ }) {
    const params = {
      fields: this.fields,
      ids: this.ids,
      sort_order: this.sortOrder,
      sort_by: this.sortBy,
      converted: this.converted,
      approved: this.approved,
      page: this.page,
      per_page: this.perPage,
      cvid: this.cvId,
      territory_id: this.territoryId,
      include_child: this.includeChild,
    };
    const response = await this.zohoCrm.listRecords(this.module, this.page, params, $);
    $.export("$summary", "Successfully listed objects");
    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
Zoho CRM	`zohoCrm`	`app`	This component uses the Zoho CRM app.
Module	`module`	`string`	Select a value from the drop down menu.
Fields	`fields`	`string`	To retrieve specific field values. Comma separated field API names.
IDs	`ids`	`string`	To retrieve specific records based on their unique ID.
Sort Order	`sortOrder`	`string`	Select a value from the drop down menu:`ascdesc`
Sort By	`sortBy`	`string`	Specify the API name of the field based on which the records must be sorted.
Converted	`converted`	`string`	Select a value from the drop down menu:`falsetrueboth`
Approved	`approved`	`string`	Select a value from the drop down menu:`falsetrueboth`
Page	`page`	`string`	To get the list of records from the respective pages.
Per Page	`perPage`	`string`	To get the list of records available per page.
Custom View ID	`cvId`	`string`	To get the list of records in a custom view.
Territory ID	`territoryId`	`string`	To get the list of records in a territory.
Include Child	`includeChild`	`boolean`	To include records from the child territories

Action Authentication#

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

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

ZohoCRM.settings.allZohoCRM.users.allZohoCRM.org.allZohoCRM.modules.allZohoCRM.bulk.allZohoCRM.notifications.readZohoCRM.notifications.createZohoCRM.notifications.updateZohoCRM.notifications.deleteZohoCRM.coql.READZohoCRM.functions.execute.READZohoCRM.functions.execute.CREATEZohoCRM.templates.email.READZohoCRM.templates.inventory.READ

About Zoho CRM#

Zoho CRM is an online Sales CRM software that manages your sales, marketing, and support in one CRM platform.

More Ways to Connect Zoho CRM + Gmail#

Other Popular Integrations#

Convert Lead with Zoho CRM API on New Labeled Email from Gmail API

Gmail + Zoho CRM

List Objects with Zoho CRM API on New Labeled Email from Gmail API

Pipedream makes it easy to connect APIs for Zoho CRM, Gmail 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