Create Document with Click2Mail API on New User from Zoho CRM API

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

Trigger workflow on

New User from the Zoho CRM API

Next, do this

Create Document with the Click2Mail 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 Click2Mail 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 Document action
1. Connect your Click2Mail account
2. Select a Upload Type
3. Optional- Configure Document Name
4. Select a Document Format
5. Select a Document Class
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 Document on Click2Mail

Description:Creates a new document in your account from an uploaded file or a URL. [See the documentation for file](https://developers.click2mail.com/reference/createdocument_1). [See the documentation for URL](https://developers.click2mail.com/reference/createdocumentfromurl)

Version:0.0.1

Key:click2mail2-create-document

View on GitHub

Click2Mail Overview#

The Click2Mail API enables automated mailing solutions, letting you integrate direct mail processes within your digital workflows. On Pipedream, you can harness this API to craft serverless workflows that interact with other apps and services. Create, manage, and send postal mail without leaving your digital ecosystem. Automate mail for marketing, invoicing, or any correspondence that requires a physical mail presence.

Action Code#

import FormData from "form-data";
import fs from "fs";
import click2mail2 from "../../click2mail2.app.mjs";
import { FORMATS } from "../../common/constants.mjs";

export default {
  key: "click2mail2-create-document",
  name: "Create Document",
  version: "0.0.1",
  description: "Creates a new document in your account from an uploaded file or a URL. [See the documentation for file](https://developers.click2mail.com/reference/createdocument_1).  [See the documentation for URL](https://developers.click2mail.com/reference/createdocumentfromurl)",
  type: "action",
  props: {
    click2mail2,
    uploadType: {
      type: "string",
      label: "Upload Type",
      description: "The type of the upload.",
      reloadProps: true,
      options: [
        "URL",
        "File",
      ],
    },
    documentName: {
      type: "string",
      label: "Document Name",
      description: "Document name as it will be stored in your account.",
      optional: true,
    },
    documentFormat: {
      type: "string",
      label: "Document Format",
      description: "The format of the document.",
      options: FORMATS,
    },
    documentClass: {
      propDefinition: [
        click2mail2,
        "documentClass",
      ],
    },
  },
  async additionalProps() {
    const props = {};
    if (this.uploadType === "URL") {
      props.url = {
        type: "string",
        label: "URL",
        description: "Document url",
      };
    } else {
      props.file = {
        type: "string",
        label: "File",
        description: "Path of the file in /tmp folder. To upload a file to /tmp folder, please follow the [doc here](https://pipedream.com/docs/code/nodejs/working-with-files/#writing-a-file-to-tmp)",
      };
    }
    return props;
  },
  async run({ $ }) {
    const {
      click2mail2,
      uploadType,
      file,
      ...params
    } = this;

    let objToSend = {};

    if (uploadType === "File") {
      const formData = new FormData();
      formData.append("file", fs.createReadStream(file));

      objToSend = {
        data: formData,
        headers: formData.getHeaders(),
      };
    }
    const response = await click2mail2.create({
      $,
      path: `${uploadType === "File"
        ? "documents"
        : "documents/url"}`,
      params,
      ...objToSend,
    });

    $.export("$summary", `A new file with Id: ${response.id} was successfully created!`);
    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
Click2Mail	`click2mail2`	`app`	This component uses the Click2Mail app.
Upload Type	`uploadType`	`string`	Select a value from the drop down menu:`URLFile`
Document Name	`documentName`	`string`	Document name as it will be stored in your account.
Document Format	`documentFormat`	`string`	Select a value from the drop down menu:`PDFDOCDOCXPUBPPTPPTXODTJPEGJPGPNG`
Document Class	`documentClass`	`string`	Select a value from the drop down menu:`Postcard 6 x 11Postcard 5 x 8Postcard 4.25 x 6Postcard 3.5 x 5Postcard 4 x 9Postcard 6 x 9Notecard 4.25 x 5.5Notecard - Folded 4.25 x 5.5Rack Card 4 x 9 - MailedFlyer 8.5 x 11Brochure 11 x 8.5Letter 8.5 x 11Letter 8.5 x 14Secure Self Mailer 8.5 x 11Booklet Self Mailer 8.5 x 11Booklet 8.5 x 11 - Address Front PageBooklet 8.5 x 11 - Address Back PageReply Letter 8.5 x 11Reply Postcard 4.25 x 6Certified Letter 8.5 x 11Certified Self Mailer 8.5 x 11Certified Self Mailer - with Green Card ReceiptPriority Letter 8.5 x 11Priority Mail Express Letter 8.5 x 11EDDM Mailer 6.25 x 11EDDM Mailer 6.5 x 9EDDM Mailer 8.5 x 12EDDM Mailer 8.5 x 11Postcard 3.5 x 5 - ShippedBrochure 11 x 8.5 - ShippedPostcard 4.25 x 6 - ShippedPostcard 5 x 8 - ShippedPostcard 6 x 11 - ShippedPostcard 6.5 x 9 - ShippedCardstock 12 x 4.5 - ShippedFlyer 8.5 x 11 - ShippedPostcard 4 x 9 - ShippedRack Card 4 x 9 - ShippedPostcard 4.25 x 6 Movers Format`

Create Document with Click2Mail API on New User from Zoho CRM API

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