Get record (or create one if not found) with Data Stores API on New Lead Created from Vtiger CRM API

Pipedream makes it easy to connect APIs for Data Stores, Vtiger CRM and 2,500+ other apps remarkably fast.

Trigger workflow on

New Lead Created from the Vtiger CRM API

Next, do this

Get record (or create one if not found) with the Data Stores 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 Vtiger CRM trigger and Data Stores action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Lead Created trigger
1. Connect your Vtiger CRM account
2. Configure timer
Configure the Get record (or create one if not found) action
1. Connect your Data Stores account
2. Configure Data Store
3. Select a Key
4. Optional- Select a Create a new record if the key is not found?
5. Optional- Configure Time to Live (TTL)
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 Lead Created on Vtiger CRM

Description:Emit new event when a new lead is created in VTiger CRM.

Version:0.0.1

Key:vtiger_crm-new-lead-created

View on GitHub

Vtiger CRM Overview#

The Vtiger CRM API lets you tap into your customer relationship data to create, read, update, and delete records across various entities such as contacts, leads, and opportunities. In Pipedream, you can leverage this API to automate workflows, sync data across platforms, and react to events in real-time, all without the need for dedicated backend code. You can create dynamic workflows that respond to webhooks, schedule tasks, and integrate with 1000+ apps readily available on Pipedream.

Trigger Code#

import base from "../common/base.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...base,
  key: "vtiger_crm-new-lead-created",
  name: "New Lead Created",
  description: "Emit new event when a new lead is created in VTiger CRM.",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  methods: {
    ...base.methods,
    async getResources(modifiedTime) {
      const { result: { updated: leads } } = await this.vtiger.getSync({
        params: {
          modifiedTime,
          elementType: "Leads",
          syncType: "user",
        },
      });
      return leads;
    },
    getTsField() {
      return "createdtime";
    },
    generateMeta(lead) {
      return {
        id: lead.id,
        summary: `New Lead with ID ${lead.id}`,
        ts: Date.parse(lead.createdtime),
      };
    },
  },
  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
Vtiger CRM	`vtiger`	`app`	This component uses the Vtiger CRM app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`

Trigger Authentication#

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

To retrieve your Access Key,

Navigate to your Vtiger CRM account and sign in
Click the dropdown on the to right
Go to “My Preferences”

Your instance is 1234.abc if your Vtiger CRM dashboard URL is https://1234.abc.vtiger.com/
Enter the email address you use to log into VTiger CRM as the username

About Vtiger CRM#

Vtiger all-in-one CRM empowers you to align your marketing, sales and support teams with unified customer data powered by One View

Action#

Get record (or create one if not found) on Data Stores

Description:Get a single record in your [Pipedream Data Store](https://pipedream.com/data-stores/) or create one if it doesn't exist.

Version:0.0.13

Key:data_stores-get-record-or-create

View on GitHub

Data Stores Overview#

Data Stores are a key-value store that allow you to persist state and share data across workflows. You can perform CRUD operations, enabling dynamic data management within your serverless architecture. Use it to save results from API calls, user inputs, or interim data; then read, update, or enrich this data in subsequent steps or workflows. Data Stores simplify stateful logic and cross-workflow communication, making them ideal for tracking process statuses, aggregating metrics, or serving as a simple configuration store.

Action Code#

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

export default {
  key: "data_stores-get-record-or-create",
  name: "Get record (or create one if not found)",
  description: "Get a single record in your [Pipedream Data Store](https://pipedream.com/data-stores/) or create one if it doesn't exist.",
  version: "0.0.13",
  type: "action",
  props: {
    app,
    dataStore: {
      propDefinition: [
        app,
        "dataStore",
      ],
    },
    key: {
      propDefinition: [
        app,
        "key",
        ({ dataStore }) => ({
          dataStore,
        }),
      ],
      description: "Select the key for the data you'd like to retrieve, or enter one manually.",
    },
    addRecordIfNotFound: {
      propDefinition: [
        app,
        "addRecordIfNotFound",
      ],
    },
    ttl: {
      propDefinition: [
        app,
        "ttl",
      ],
    },
  },
  async additionalProps() {
    const props = {};
    if (this.app.shouldAddRecord(this.addRecordIfNotFound)) {
      props.value = app.propDefinitions.value;
    }
    return props;
  },
  async run({ $ }) {
    const record = await this.dataStore.get(this.key);
    let summary, response;

    if (record !== undefined) {
      summary = `Found data for the key, \`${this.key}\`.`;
      response = record;
    }
    else if (!this.app.shouldAddRecord(this.addRecordIfNotFound)) {
      summary = `No data found for key, \`${this.key}\`.`;
    }
    else {
      const parsedValue = this.app.parseValue(this.value);

      if (this.ttl) {
        await this.dataStore.set(this.key, parsedValue, {
          ttl: this.ttl,
        });
        summary = `Successfully added a new record with the key, \`${this.key}\` (expires in ${this.app.formatTtl(this.ttl)}).`;
      } else {
        await this.dataStore.set(this.key, parsedValue);
        summary = `Successfully added a new record with the key, \`${this.key}\`.`;
      }

      response = parsedValue;

      // Include TTL information in the return value if it was set
      if (this.ttl) {
        response = {
          value: parsedValue,
          ttl: this.ttl,
        };
      }
    }

    $.export("$summary", summary);
    $.export("key", this.key);
    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
Data Stores	`app`	`app`	This component uses the Data Stores app.
Data Store	`dataStore`	`data_store`	Select an existing Data Store or create a new one.
Key	`key`	`string`	Select a value from the drop down menu.
Create a new record if the key is not found?	`addRecordIfNotFound`	`string`	Select a value from the drop down menu:`YesNo`
Time to Live (TTL)	`ttl`	`integer`	The number of seconds until this record expires and is automatically deleted. Examples: 3600 (1 hour), 86400 (1 day), 604800 (1 week). Leave blank for records that should not expire.