Create or Update Contact or Event with Regal API on New User from Zoho CRM API

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

Trigger workflow on

New User from the Zoho CRM API

Next, do this

Create or Update Contact or Event with the Regal 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 Zoho CRM trigger and Regal 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 trigger
1. Connect your Zoho CRM account
2. Configure Polling Interval
3. Select a User Type
Configure the Create or Update Contact or Event action
1. Connect your Regal account
2. Optional- Configure User ID
3. Optional- Configure First Name
4. Optional- Configure Last Name
5. Optional- Configure Event Name
6. Optional- Configure Event Source
7. Optional- Configure Email
8. Optional- Configure Phone
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 on Zoho CRM

Description:Emits an event each time a new user is created in Zoho CRM

Version:0.0.10

Key:zoho_crm-new-user

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.

Trigger Code#

import common from "../common/timer-based/base.mjs";
import userTypes from "./common-user-types.mjs";

export default {
  ...common,
  key: "zoho_crm-new-user",
  name: "New User",
  description: "Emits an event each time a new user is created in Zoho CRM",
  version: "0.0.10",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    userType: {
      type: "string",
      label: "User Type",
      description: "The type of users to generate events for",
      options: userTypes,
    },
  },
  hooks: {
    async activate() {
      const userCount = await this.zohoCrm.getUserCount({
        type: this.userType,
      });
      this._setUserCount(userCount);
    },
  },
  methods: {
    ...common.methods,
    _getUserCount() {
      return this.db.get("userCount");
    },
    _setUserCount(userCount) {
      this.db.set("userCount", userCount);
    },
    generateMeta({
      user,
      event,
    }) {
      const {
        id,
        first_name: firstName = "",
        last_name: lastName = "",
      } = user;
      const lastNameInitial = lastName
        ? `${lastName.slice(0, 1)}.`
        : "";
      const userNameDisplay = `${firstName} ${lastNameInitial}`;
      const summary = `New User: ${userNameDisplay}`;
      const { timestamp: ts } = event;
      return {
        id,
        summary,
        ts,
      };
    },
    async processEvent(event) {
      const lastUserCount = this._getUserCount();
      const usersPage = this.zohoCrm.computeLastUsersPage({
        userCount: lastUserCount,
      });
      let usersOffset = this.zohoCrm.computeUsersOffset({
        userCount: lastUserCount,
      });
      let newUserCount = lastUserCount;
      const userScan = await this.zohoCrm.getUsers({
        page: usersPage,
        type: this.userType,
      });
      for await (const user of userScan) {
        if (usersOffset > 0) {
          // The first items in the user retrieval could have been already
          // processed. `usersOffset` contains the amount of items that we need to
          // skip before we hit a new, unprocessed item.
          --usersOffset;
          continue;
        }

        const meta = this.generateMeta({
          user,
          event,
        });
        this.$emit(user, meta);
        ++newUserCount;
      }

      this._setUserCount(newUserCount);
    },
  },
};

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
Zoho CRM	`zohoCrm`	`app`	This component uses the Zoho CRM 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 Zoho API on this schedule
User Type	`userType`	`string`	Select a value from the drop down menu:`{ "value": "AllUsers", "label": "All users in your organization (both active and inactive users)" }{ "value": "ActiveUsers", "label": "Active Users" }{ "value": "DeactiveUsers", "label": "Users who were deactivated" }{ "value": "ConfirmedUsers", "label": "Confirmed users" }{ "value": "NotConfirmedUsers", "label": "Non-confirmed users" }{ "value": "DeletedUsers", "label": "Deleted users" }{ "value": "ActiveConfirmedUsers", "label": "Active users who are also confirmed" }{ "value": "AdminUsers", "label": "Admin users" }{ "value": "ActiveConfirmedAdmins", "label": "Active users with the administrative privileges and are also confirmed" }{ "value": "CurrentUser", "label": "The current CRM user" }`

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

Action#

Create or Update Contact or Event on Regal

Description:Create and update contacts or add events to contacts. [See the documentation](https://developer.regal.io/reference/api)

Version:0.0.1

Key:regal-custom-event

View on GitHub

Action Code#

import app from "../../regal.app.mjs";

export default {
  key: "regal-custom-event",
  name: "Create or Update Contact or Event",
  description: "Create and update contacts or add events to contacts. [See the documentation](https://developer.regal.io/reference/api)",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    userId: {
      propDefinition: [
        app,
        "userId",
      ],
    },
    firstName: {
      propDefinition: [
        app,
        "firstName",
      ],
    },
    lastName: {
      propDefinition: [
        app,
        "lastName",
      ],
    },
    name: {
      propDefinition: [
        app,
        "name",
      ],
    },
    eventSource: {
      propDefinition: [
        app,
        "eventSource",
      ],
    },
    email: {
      propDefinition: [
        app,
        "email",
      ],
    },
    phone: {
      propDefinition: [
        app,
        "phone",
      ],
    },
  },
  async run({ $ }) {
    const response = await this.app.customEvent({
      $,
      data: {
        userId: this.userId,
        traits: {
          firstName: this.firstName,
          lastName: this.lastName,
          phones: {
            [this.phone]: {},
          },
          emails: {
            [this.email]: {},
          },
        },
        name: this.name,
        eventSource: this.eventSource,
      },
    });

    $.export("$summary", `Successfully generated custom event for contact with ID '${this.userId}'`);

    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
Regal	`app`	`app`	This component uses the Regal app.
User ID	`userId`	`string`	Unique identifier for your contact
First Name	`firstName`	`string`	First name of the contact
Last Name	`lastName`	`string`	Last name of the contact
Event Name	`name`	`string`	Name of the event
Event Source	`eventSource`	`string`	Source of the event
Email	`email`	`string`	Email address of the contact
Phone	`phone`	`string`	Phone number of the contact

Action Authentication#

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

About Regal#

Outbound Cloud Contact Center Software.

More Ways to Connect Regal + Zoho CRM#

Other Popular Integrations#

Create or Update Contact or Event with Regal API on New Contact (Instant) from Zoho CRM API

Zoho CRM + Regal

Create or Update Contact or Event with Regal API on New User from Zoho CRM API

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