Create Affiliate Lead with Relavate API on New Event (Instant) from Zoho CRM API

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

Trigger workflow on

New Event (Instant) from the Zoho CRM API

Next, do this

Create Affiliate Lead with the Relavate 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 Relavate action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Event (Instant) trigger
1. Connect your Zoho CRM account
2. Configure Subscription Renewal Timer
3. Select one or more Events
Configure the Create Affiliate Lead action
1. Connect your Relavate account
2. Select a Campaign ID
3. Select a Status
4. Configure Client
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 Event (Instant) on Zoho CRM

Description:Emit new custom events from Zoho CRM

Version:0.0.15

Key:zoho_crm-new-event

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 sortBy from "lodash.sortby";
import common from "../common/http-based/base.mjs";
import crudOps from "../common/http-based/common-crud-operations.mjs";

export default {
  ...common,
  key: "zoho_crm-new-event",
  name: "New Event (Instant)",
  description: "Emit new custom events from Zoho CRM",
  version: "0.0.15",
  type: "source",
  props: {
    ...common.props,
    events: {
      type: "string[]",
      label: "Events",
      description: "Choose one or more module events to trigger this event source.",
      async options({ page = 0 }) {
        if (page !== 0) {
          return [];
        }

        const { modules } = await this.zohoCrm.listModules();
        return sortBy(modules.flatMap(this._moduleSupportedEvents), "label");
      },
    },
  },
  methods: {
    ...common.methods,
    _moduleSupportedEvents(module) {
      // See the docs for more information about these attributes:
      // https://www.zoho.com/crm/developer/docs/api/v2/modules-api.html
      const {
        api_name: moduleKey,
        singular_label: moduleName,
      } = module;

      // As per the docs, the notation for a CRUD event on a record/module is
      // {capitalized record name}.{operation} (e.g. `Contacts.create` will
      // issue notifications when a contact is created). See the docs for more
      // details:
      // https://www.zoho.com/crm/developer/docs/api/v2/notifications/enable.html
      return this
        .getSupportedOps()
        .filter(({ flagName }) => module[flagName])
        .map(({
          description,
          op,
        }) => ({
          label: `${moduleName} ${description}`,
          value: `${moduleKey}.${op}`,
        }));
    },
    getSupportedOps() {
      return crudOps.allOpsData();
    },
    getEvents() {
      return this.events;
    },
  },
};

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.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
Subscription Renewal Timer	`timer`	`$.interface.timer`	Zoho CRM webhooks subscriptions have an expiration date of up to 1 day. This event source renews the subscription every 12 hours by default.
Events	`events`	`string[]`	Select a value from the drop down menu.

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 Affiliate Lead on Relavate

Description:This component enables you to create a new affiliate lead for marketing. [See the documentation](https://api.relavate.co/#2a307851-9d54-42ea-9f54-3fb600b152a5)

Version:0.0.1

Key:relavate-create-affiliate-lead

View on GitHub

Relavate Overview#

The Relavate API provides tools for managing customer relations and sales efforts, enabling users to automate and optimize their CRM activities. With capabilities for managing contacts, companies, deals, and tasks, the API can serve as a backbone for CRM automation, enhancing customer interaction and business processes efficiency. On Pipedream, you can leverage these functionalities to create advanced workflows, integrate with other apps, and automate tasks based on events from the Relavate system or external triggers.

Action Code#

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

export default {
  key: "relavate-create-affiliate-lead",
  name: "Create Affiliate Lead",
  description: "This component enables you to create a new affiliate lead for marketing. [See the documentation](https://api.relavate.co/#2a307851-9d54-42ea-9f54-3fb600b152a5)",
  version: "0.0.1",
  type: "action",
  props: {
    relavate,
    campaignId: {
      propDefinition: [
        relavate,
        "campaignId",
      ],
      reloadProps: true,
    },
    status: {
      type: "string",
      label: "Status",
      description: "The status of the lead being created",
      options: [
        "Pending",
        "Won",
      ],
    },
    client: {
      type: "string",
      label: "Client",
      description: "The company or name of the client",
    },
  },
  async additionalProps() {
    const props = {};
    const partnerType = this.relavate.getPartnerType();
    if (partnerType === "partner") {
      props.vendorId = {
        type: "string",
        label: "Vendor ID",
        description: "The ID of the vendor",
        options: async () => await this.getVendorIdPropOptions(),
      };
    }
    if (partnerType === "vendor") {
      props.partnerId = {
        type: "string",
        label: "Partner ID",
        description: "The ID of the partner",
        options: async () => await this.getPartnerIdPropOptions(),
      };
    }
    return props;
  },
  methods: {
    async getVendorIdPropOptions() {
      const vendors = await this.relavate.listVendors();
      const vendorIds = vendors?.map(({ vendorID }) => vendorID );
      const options = [];
      for (const vendorId of vendorIds) {
        const { name } = await this.relavate.getVendor({
          vendorId,
        });
        options.push({
          value: vendorId,
          label: name,
        });
      }
      return options;
    },
    async getPartnerIdPropOptions() {
      const partners = await this.relavate.listPartners();
      const partnerIds = partners?.map(({ partnerID }) => partnerID );
      const options = [];
      for (const partnerId of partnerIds) {
        const { name } = await this.relavate.getPartner({
          partnerId,
        });
        options.push({
          value: partnerId,
          label: name,
        });
      }
      return options;
    },
  },
  async run({ $ }) {
    const response = await this.relavate.createAffiliateLead({
      $,
      params: {
        campaignID: this.campaignId,
        client: this.client,
        status: this.status,
        vendorID: this.vendorId,
        partnerID: this.partnerId,
      },
    });
    $.export("$summary", `Created affiliate lead with ID: ${response.id}`);
    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
Relavate	`relavate`	`app`	This component uses the Relavate app.
Campaign ID	`campaignId`	`string`	Select a value from the drop down menu.
Status	`status`	`string`	Select a value from the drop down menu:`PendingWon`
Client	`client`	`string`	The company or name of the client

Action Authentication#

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

To retrieve your API Key, API Secret, and Partner Type,

Navigate to your Relavate account and sign in
Click the user dropdown on the top right.
Go to “Account” > “Organisation ”> “API”

Create Affiliate Lead with Relavate API on New Event (Instant) from Zoho CRM API

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

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

Developers ♥ Pipedream

1-24of2,200+apps by most popular

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