Convert Lead with Zoho CRM API on New User Created from Vitally API

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

Trigger workflow on

New User Created from the Vitally API

Next, do this

Convert Lead with the Zoho CRM API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Vitally 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 User Created trigger
1. Connect your Vitally account
2. Configure Polling interval
3. Optional- Select a Account Id
4. Optional- Select a Organization Id
Configure the Convert Lead action
1. Connect your Zoho CRM account
2. Select a Lead
3. Optional- Select a Account
4. Optional- Select a Contact
5. Optional- Select a User
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 User Created on Vitally

Description:Emit new event when a new user is created.

Version:0.0.2

Key:vitally-new-user-created

View on GitHub

Vitally Overview#

The Vitally API offers a window into customer success operations, enabling you to automate workflows, integrate with other tools, and manipulate customer data programmatically. With Pipedream, you can harness this API to create custom automations that react to events in Vitally, sync data between Vitally and other platforms, or maintain up-to-date customer profiles across your business stack.

Trigger Code#

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

export default {
  key: "vitally-new-user-created",
  name: "New User Created",
  version: "0.0.2",
  description: "Emit new event when a new user is created.",
  type: "source",
  dedupe: "unique",
  props: {
    vitally,
    db: "$.service.db",
    timer: {
      label: "Polling interval",
      description: "Pipedream will poll the Vitally on this schedule",
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    accountId: {
      propDefinition: [
        vitally,
        "accountId",
      ],
      optional: true,
    },
    organizationId: {
      propDefinition: [
        vitally,
        "organizationId",
      ],
      optional: true,
    },
  },
  methods: {
    _getLastDate() {
      return this.db.get("lastDate") || 0;
    },
    _setLastDate(lastDate) {
      this.db.set("lastDate", lastDate);
    },
    async startEvent(maxResults) {
      const {
        vitally,
        accountId,
        organizationId,
      } = this;

      let responseArray = [];
      const lastDate = this._getLastDate();
      const items = vitally.paginate({
        fn: vitally.listUsers,
        accountId,
        organizationId,
        maxResults,
        params: {
          sortBy: "createdAt",
        },
      });

      for await (const item of items) {
        if (moment(item.createdAt).isSameOrBefore(lastDate)) {
          break;
        }
        responseArray.push(item);
      }

      if (responseArray.length) {
        this._setLastDate(responseArray[0].createdAt);
      }

      for (const responseItem of responseArray.reverse()) {
        this.$emit(
          responseItem,
          {
            id: responseItem.id,
            summary: `A new user with id: "${responseItem.id}" was created!`,
            ts: responseItem.createdAt,
          },
        );
      }
    },
  },
  hooks: {
    async deploy() {
      await this.startEvent(25);
    },
  },
  async run() {
    await this.startEvent();
  },
};

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
Vitally	`vitally`	`app`	This component uses the Vitally 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 Vitally on this schedule
Account Id	`accountId`	`string`	Select a value from the drop down menu.
Organization Id	`organizationId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

To retrieve your API Key,

Click the drop down on the top left with Vitally logo
Go to “Settings” > “Integrations” > Vitally REST API
Copy the API Key under Secret Token

About Vitally#

Modern #CustomerSuccess for B2B SaaS. 🚀 Unify your data, understand it deeply, and build powerful automation to drive a world-class customer experience.

Action#

Convert Lead on Zoho CRM

Description:Converts a Lead into a Contact or an Account. [See the documentation](https://www.zoho.com/crm/developer/docs/api/v2/convert-lead.html)

Version:0.1.1

Key:zoho_crm-convert-lead

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-convert-lead",
  name: "Convert Lead",
  description: "Converts a Lead into a Contact or an Account. [See the documentation](https://www.zoho.com/crm/developer/docs/api/v2/convert-lead.html)",
  version: "0.1.1",
  type: "action",
  props: {
    zohoCrm,
    lead: {
      propDefinition: [
        zohoCrm,
        "recordId",
        () => ({
          module: "Leads",
        }),
      ],
      label: "Lead",
      description: "Unique identifier of the lead record to be converted",
    },
    account: {
      propDefinition: [
        zohoCrm,
        "recordId",
        () => ({
          module: "Accounts",
        }),
      ],
      label: "Account",
      description: "Use this key to associate an account with the lead being converted. Pass the unique and valid account ID.",
      optional: true,
    },
    contact: {
      propDefinition: [
        zohoCrm,
        "recordId",
        () => ({
          module: "Contacts",
        }),
      ],
      label: "Contact",
      description: "Use this key to associate a contact with the lead being converted. Pass the unique and valid contact ID.",
      optional: true,
    },
    user: {
      propDefinition: [
        zohoCrm,
        "recordId",
        () => ({
          module: "users?type=ActiveUsers",
        }),
      ],
      label: "User",
      description: "Use this key to assign record owner for the new contact and account. Pass the unique and valid user ID.",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      lead,
      account,
      contact,
      user,
    } = this;
    const data = {
      data: [
        this.zohoCrm.omitEmptyStringValues({
          Accounts: account,
          Contacts: contact,
          assign_to: user,
        }),
      ],
    };
    const res = await this.zohoCrm.convertLead(lead, data, $);
    $.export("$summary", "Successfully converted lead");
    return res;
  },
};

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.
Lead	`lead`	`string`	Select a value from the drop down menu.
Account	`account`	`string`	Select a value from the drop down menu.
Contact	`contact`	`string`	Select a value from the drop down menu.
User	`user`	`string`	Select a value from the drop down menu.

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

Convert Lead with Zoho CRM API on New User Created from Vitally API

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

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

Developers ♥ Pipedream

1-24of2,000+apps by most popular

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