Update Deal with OnePageCRM API on New Contact from Twilio SendGrid API

Pipedream makes it easy to connect APIs for OnePageCRM, Twilio SendGrid and 2,400+ other apps remarkably fast.

Trigger workflow on

New Contact from the Twilio SendGrid API

Next, do this

Update Deal with the OnePageCRM 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 Twilio SendGrid trigger and OnePageCRM action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Contact trigger
1. Connect your Twilio SendGrid account
2. Configure timer
Configure the Update Deal action
1. Connect your OnePageCRM account
2. Select a Deal ID
3. Optional- Select a Contact ID
4. Optional- Select a User ID
5. Optional- Select a Pipeline ID
6. Optional- Configure Name
7. Optional- Configure Text
8. Optional- Select a Stage
9. Optional- Select a Status
10. Optional- Configure Expected Close Date
11. Optional- Configure Close Date
12. Optional- Configure Date
13. Optional- Configure Amount
14. Optional- Configure Months
15. Optional- Configure Cost
16. Optional- Select a Commission Base
17. Optional- Select a Commission Type
18. Optional- Configure Commission
19. Optional- Configure Commission Percentage
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 Contact on Twilio SendGrid

Description:Emit new event when a new contact is created

Version:0.0.7

Key:sendgrid-new-contact

View on GitHub

Twilio SendGrid Overview#

The Twilio SendGrid API opens up a world of possibilities for email automation, enabling you to send emails efficiently and track their performance. With this API, you can programmatically create and send personalized email campaigns, manage contacts, and parse inbound emails for data extraction. When you harness the power of Pipedream, you can connect SendGrid to hundreds of other apps to automate workflows, such as triggering email notifications based on specific actions, syncing email stats with your analytics, or handling incoming emails to create tasks or tickets.

Trigger Code#

import orderBy from "lodash/orderBy.js";
import common from "../common/timer-based.mjs";

export default {
  ...common,
  key: "sendgrid-new-contact",
  name: "New Contact",
  description: "Emit new event when a new contact is created",
  version: "0.0.7",
  type: "source",
  dedupe: "unique",
  hooks: {
    async activate() {
      const currentTimestamp = Date.now();
      const state = {
        processedItems: [],
        lowerTimestamp: currentTimestamp,
        upperTimestamp: currentTimestamp,
      };
      this.db.set("state", state);
    },
  },
  methods: {
    ...common.methods,
    _maxDelayTime() {
      // There is no report from SendGrid as to how much time it takes
      // for a contact to be created and appear in search results, so
      // we're using a rough estimate of 30 minutes here.
      return 30 * 60 * 1000;  // 30 minutes, in milliseconds
    },
    _addDelayOffset(timestamp) {
      return timestamp - this._maxDelayTime();
    },
    _cleanupOldProcessedItems(processedItems, currentTimestamp) {
      return processedItems
        .map((item) => ({
          // We just need to keep track of the record ID and
          // its creation date.
          id: item.id,
          created_at: item.created_at,
        }))
        .filter((item) => {
          const { created_at: createdAt } = item;
          const createdAtTimestamp = Date.parse(createdAt);
          const cutoffTimestamp = this._addDelayOffset(currentTimestamp);
          return createdAtTimestamp > cutoffTimestamp;
        });
    },
    _makeSearchQuery(processedItems, lowerTimestamp, upperTimestamp) {
      const idList = processedItems
        .map((item) => item.id)
        .map((id) => `'${id}'`)
        .join(", ")
      || "''";
      const startTimestamp = this._addDelayOffset(lowerTimestamp);
      const startDate = this.toISOString(startTimestamp);
      const endDate = this.toISOString(upperTimestamp);
      return `
        contact_id NOT IN (${idList}) AND
        created_at BETWEEN
          TIMESTAMP '${startDate}' AND
          TIMESTAMP '${endDate}'
      `;
    },
    generateMeta(data) {
      const {
        item,
        eventTimestamp: ts,
      } = data;
      const {
        id,
        email,
      } = item;
      const slugifiedEmail = this.slugifyEmail(email);
      const summary = `New contact: ${slugifiedEmail}`;
      return {
        id,
        summary,
        ts,
      };
    },
    async processEvent(event) {
      // Transform the timer timestamp to milliseconds
      // to be consistent with how Javascript handles timestamps.
      const eventTimestamp = event.timestamp * 1000;

      // Retrieve the current state of the component.
      const {
        processedItems,
        lowerTimestamp,
        upperTimestamp,
      } = this.db.get("state");

      // Search for contacts within a specific timeframe, excluding
      // items that have already been processed.
      const query = this._makeSearchQuery(processedItems, lowerTimestamp, upperTimestamp);
      const {
        result: items,
        contact_count: contactCount,
      } = await this.sendgrid.searchContacts(query);

      // If no contacts have been retrieved via the API,
      // move the time window forward to possibly capture newer contacts.
      if (contactCount === 0) {
        const newState = {
          processedItems: this._cleanupOldProcessedItems(processedItems, lowerTimestamp),
          lowerTimestamp: upperTimestamp,
          upperTimestamp: eventTimestamp,
        };
        this.db.set("state", newState);
        return;
      }

      // We process the searched records from oldest to newest.
      const itemsToProcess = orderBy(items, "created_at");
      itemsToProcess
        .forEach((item) => {
          const meta = this.generateMeta({
            item,
            eventTimestamp,
          });
          this.$emit(item, meta);
        });

      // Use the timestamp of the last processed record as a lower bound for
      // following searches. This bound will be subjected to an offset so in
      // case older records appear in future search results, but have not
      // appeared until now, can be processed. We only adjust it if it means
      // moving forward, not backwards. Otherwise, we might start retrieving
      // older and older records indefinitely (and we're all about *new*
      // records!)
      const newLowerTimestamp = Math.max(
        lowerTimestamp,
        Date.parse(itemsToProcess[0].created_at),
      );

      // If the total contact count is less than 100, it means that during the
      // next iteration the search results count will most likely be less than
      // 50. In that case, if we extend the upper bound of the search time range
      // we might be able to retrieve more records.
      const newUpperTimestamp = contactCount < 100
        ? eventTimestamp
        : upperTimestamp;

      // The list of processed items can grow indefinitely.
      // Since we don't want to keep track of every processed record
      // ever, we need to clean up this list, removing any records
      // that are no longer relevant.
      const newProcessedItems = this._cleanupOldProcessedItems(
        [
          ...processedItems,
          ...itemsToProcess,
        ],
        newLowerTimestamp,
      );

      // Update the state of the component to reflect the computations
      // made above.
      const newState = {
        processedItems: newProcessedItems,
        lowerTimestamp: newLowerTimestamp,
        upperTimestamp: newUpperTimestamp,
      };
      this.db.set("state", newState);
    },
  },
};

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
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Twilio SendGrid	`sendgrid`	`app`	This component uses the Twilio SendGrid app.
	`timer`	`$.interface.timer`

Trigger Authentication#

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

About Twilio SendGrid#

Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.

Action#

Update Deal on OnePageCRM

Description:Updates an existing deal's details in OnePageCRM. [See the documentation](https://developer.onepagecrm.com/api/)

Version:0.0.1

Key:onepagecrm-update-deal

View on GitHub

OnePageCRM Overview#

The OnePageCRM API enables interaction with your OnePageCRM account, automating your contact and sales management. With it, you can create, update, and delete contacts, deals, and notes, or trigger actions based on sales activities. When combined with Pipedream's serverless platform, this API allows you to connect OnePageCRM with hundreds of other apps to streamline your sales process, enhance lead generation, and improve follow-ups.

Action Code#

import { STAGE_OPTIONS } from "../../common/constants.mjs";
import onepagecrm from "../../onepagecrm.app.mjs";

export default {
  key: "onepagecrm-update-deal",
  name: "Update Deal",
  description: "Updates an existing deal's details in OnePageCRM. [See the documentation](https://developer.onepagecrm.com/api/)",
  version: "0.0.1",
  type: "action",
  props: {
    onepagecrm,
    dealId: {
      propDefinition: [
        onepagecrm,
        "dealId",
      ],
    },
    contactId: {
      propDefinition: [
        onepagecrm,
        "contactId",
      ],
      optional: true,
    },
    ownerId: {
      propDefinition: [
        onepagecrm,
        "userId",
      ],
      optional: true,
    },
    pipelineId: {
      propDefinition: [
        onepagecrm,
        "pipelineId",
      ],
      optional: true,
    },
    name: {
      type: "string",
      label: "Name",
      description: "Name of the deal.",
      optional: true,
    },
    text: {
      type: "string",
      label: "Text",
      description: "Extra notes related to the deal (supports [b]bold[/b] and [i]italic[/i] formatting).",
      optional: true,
    },
    stage: {
      type: "integer",
      label: "Stage",
      description: "A numerical representation of the progress of a pending deal.",
      options: STAGE_OPTIONS,
      optional: true,
    },
    status: {
      type: "string",
      label: "Status",
      description: "Status of the deal.",
      options: [
        "pending",
        "won",
        "lost",
      ],
      optional: true,
    },
    expectedCloseDate: {
      type: "string",
      label: "Expected Close Date",
      description: "The date the deal is expected to close. **Format: YYYY-MM-DD**. **(status should be `pending`)**.",
      optional: true,
    },
    closeDate: {
      type: "string",
      label: "Close Date",
      description: "The date the deal actually closed. **(status should be `won` or `lost`)`**.",
      optional: true,
    },
    date: {
      type: "string",
      label: "Date",
      description: "Creation date of the deal.",
      optional: true,
    },
    amount: {
      type: "string",
      label: "Amount",
      description: "The monitary value of the deal (per month, if multi-month deal).",
      optional: true,
    },
    months: {
      type: "integer",
      label: "Months",
      description: "Number of months the deal is to be paid for. (1 for regular deals, 2+ for multi-month).",
      default: 1,
      optional: true,
    },
    cost: {
      type: "string",
      label: "Cost",
      description: "The monitary cost of the deal",
      optional: true,
    },
    commissionBase: {
      type: "string",
      label: "Commission Base",
      description: "Base used to calculate the commission of the deal.",
      options: [
        "amount",
        "margin",
      ],
      optional: true,
    },
    commissionType: {
      type: "string",
      label: "Commission Type",
      description: "Type of commission for the deal.",
      options: [
        "none",
        "percentage",
        "absolute",
      ],
      optional: true,
    },
    commission: {
      type: "string",
      label: "Commission",
      description: "Commission payable for the deal.",
      optional: true,
    },
    commissionPercentage: {
      type: "string",
      label: "Commission Percentage",
      description: "Commission percentage for the deal.",
      optional: true,
    },
  },
  async run({ $ }) {
    const { data: { deal } } = await this.onepagecrm.getDeal({
      $,
      dealId: this.dealId,
    });
    if (this.contactId) deal.contact_id = this.contactId;
    if (this.ownerId) deal.owner_id = this.ownerId;
    if (this.pipelineId) deal.pipeline_id = this.pipelineId;
    if (this.name) deal.name = this.name;
    if (this.text) deal.text = this.text;
    if (this.stage) deal.stage = this.stage;
    if (this.status) deal.status = this.status;
    if (this.expectedCloseDate) deal.expected_close_date = this.expectedCloseDate;
    if (this.closeDate) deal.close_date = this.closeDate;
    if (this.date) deal.date = this.date;
    if (this.amount) deal.amount = this.amount;
    if (this.months) deal.months = this.months;
    if (this.cost) deal.cost = this.cost;
    if (this.commissionBase) deal.commission_base = this.commissionBase;
    if (this.commissionType) deal.commission_type = this.commissionType;
    if (this.commission) deal.commission = this.commission;
    if (this.commissionPercentage) deal.commission_percentage = this.commissionPercentage;

    const response = await this.onepagecrm.updateDeal({
      $,
      dealId: this.dealId,
      data: deal,
    });

    $.export("$summary", `Successfully updated deal with ID ${this.dealId}`);
    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
OnePageCRM	`onepagecrm`	`app`	This component uses the OnePageCRM app.
Deal ID	`dealId`	`string`	Select a value from the drop down menu.
Contact ID	`contactId`	`string`	Select a value from the drop down menu.
User ID	`ownerId`	`string`	Select a value from the drop down menu.
Pipeline ID	`pipelineId`	`string`	Select a value from the drop down menu.
Name	`name`	`string`	Name of the deal.
Text	`text`	`string`	Extra notes related to the deal (supports [b]bold[/b] and [i]italic[/i] formatting).
Stage	`stage`	`integer`	Select a value from the drop down menu:`{ "label": 10, "value": 10 }{ "label": 20, "value": 20 }{ "label": 40, "value": 40 }{ "label": 60, "value": 60 }{ "label": 80, "value": 80 }`
Status	`status`	`string`	Select a value from the drop down menu:`pendingwonlost`
Expected Close Date	`expectedCloseDate`	`string`	The date the deal is expected to close. Format: YYYY-MM-DD. (status should be `pending`).
Close Date	`closeDate`	`string`	The date the deal actually closed. (status should be `won` or `lost`)`.
Date	`date`	`string`	Creation date of the deal.
Amount	`amount`	`string`	The monitary value of the deal (per month, if multi-month deal).
Months	`months`	`integer`	Number of months the deal is to be paid for. (1 for regular deals, 2+ for multi-month).
Cost	`cost`	`string`	The monitary cost of the deal
Commission Base	`commissionBase`	`string`	Select a value from the drop down menu:`amountmargin`
Commission Type	`commissionType`	`string`	Select a value from the drop down menu:`nonepercentageabsolute`
Commission	`commission`	`string`	Commission payable for the deal.
Commission Percentage	`commissionPercentage`	`string`	Commission percentage for the deal.

Action Authentication#

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

To retrieve your User ID and API Key,