Create Placement with Recruiterflow API on New Contact from Twilio SendGrid API

Pipedream makes it easy to connect APIs for Recruiterflow, Twilio SendGrid and 3,000+ other apps remarkably fast.

Trigger workflow on

New Contact from the Twilio SendGrid API

Next, do this

Create Placement with the Recruiterflow 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 Recruiterflow 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 Create Placement action
1. Connect your Recruiterflow account
2. Select a User ID
3. Select a Candidate ID
4. Select a Job ID
5. Configure Job Start Date
6. Optional- Configure Contract Start Date
7. Optional- Configure Contract End Date
8. Configure Billing Date
9. Optional- Configure Salary Amount
10. Optional- Configure Salary Currency
11. Optional- Configure Revenue Amount
12. Optional- Configure Revenue Currency
13. Optional- Configure Success Fee Amount
14. Optional- Configure Success Fee Currency
15. Optional- Configure Bonus Amount
16. Optional- Configure Bonus Currency
17. Optional- Configure Pay Rate Amount
18. Optional- Configure Pay Rate Currency
19. Optional- Select a Pay Rate Frequency
20. Optional- Configure Bill Rate Amount
21. Optional- Configure Bill Rate Currency
22. Optional- Select a Bill Rate Frequency
23. Optional- Configure Is Full Time
24. Optional- Configure Work Quantum Number
25. Optional- Configure Work Quantum Unit
26. Optional- Configure Work Quantum Frequency
27. Optional- Configure Contact IDs
28. Optional- Configure Note ID
29. Optional- Configure Revenue Split
30. Optional- Configure Custom Fields
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.8

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 3,000+ 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.8",
  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#

Create Placement on Recruiterflow

Description:Records a successful candidate placement in Recruiterflow. [See the documentation](https://recruiterflow.com/swagger.yml)

Version:0.0.1

Key:recruiterflow-create-placement

View on GitHub

Action Code#

import app from "../../recruiterflow.app.mjs";
import utils from "../../common/utils.mjs";
import constants from "../../common/constants.mjs";

export default {
  key: "recruiterflow-create-placement",
  name: "Create Placement",
  description: "Records a successful candidate placement in Recruiterflow. [See the documentation](https://recruiterflow.com/swagger.yml)",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    userId: {
      propDefinition: [
        app,
        "userId",
      ],
      label: "User ID",
      description: "The ID of the user creating the placement",
    },
    candidateId: {
      propDefinition: [
        app,
        "candidateId",
      ],
      label: "Candidate ID",
      description: "The ID of the candidate being placed",
    },
    jobId: {
      propDefinition: [
        app,
        "jobId",
      ],
      label: "Job ID",
      description: "The ID of the job for this placement",
    },
    jobStartDate: {
      type: "string",
      label: "Job Start Date",
      description: "The start date of the job (`YYYY-MM-DD` format, e.g., `2021-01-12`)",
    },
    contractStartDate: {
      type: "string",
      label: "Contract Start Date",
      description: "The contract start date (`YYYY-MM-DD` format, e.g., `2021-01-12`)",
      optional: true,
    },
    contractEndDate: {
      type: "string",
      label: "Contract End Date",
      description: "The contract end date (`YYYY-MM-DD` format, e.g., `2021-01-12`)",
      optional: true,
    },
    billingDate: {
      type: "string",
      label: "Billing Date",
      description: "The billing date (`YYYY-MM-DD` format, e.g., `2021-01-12`)",
    },
    salaryAmount: {
      type: "integer",
      label: "Salary Amount",
      description: "The salary amount",
      optional: true,
    },
    salaryCurrency: {
      type: "string",
      label: "Salary Currency",
      description: "The currency for the salary (e.g., `USD`, `EUR`, `GBP`)",
      optional: true,
    },
    revenueAmount: {
      type: "integer",
      label: "Revenue Amount",
      description: "The placement revenue/fee amount",
      optional: true,
    },
    revenueCurrency: {
      type: "string",
      label: "Revenue Currency",
      description: "The currency for the revenue (e.g., `USD`, `EUR`, `GBP`)",
      optional: true,
    },
    successFeeAmount: {
      type: "integer",
      label: "Success Fee Amount",
      description: "The success fee amount",
      optional: true,
    },
    successFeeCurrency: {
      type: "string",
      label: "Success Fee Currency",
      description: "The currency for the success fee",
      optional: true,
    },
    bonusAmount: {
      type: "integer",
      label: "Bonus Amount",
      description: "The bonus amount",
      optional: true,
    },
    bonusCurrency: {
      type: "string",
      label: "Bonus Currency",
      description: "The currency for the bonus",
      optional: true,
    },
    payRateAmount: {
      type: "integer",
      label: "Pay Rate Amount",
      description: "The pay rate amount",
      optional: true,
    },
    payRateCurrency: {
      type: "string",
      label: "Pay Rate Currency",
      description: "The currency for the pay rate",
      optional: true,
    },
    payRateFrequency: {
      type: "string",
      label: "Pay Rate Frequency",
      description: "The frequency of the pay rate",
      optional: true,
      options: constants.RATE_FREQUENCIES,
    },
    billRateAmount: {
      type: "integer",
      label: "Bill Rate Amount",
      description: "The bill rate amount",
      optional: true,
    },
    billRateCurrency: {
      type: "string",
      label: "Bill Rate Currency",
      description: "The currency for the bill rate",
      optional: true,
    },
    billRateFrequency: {
      type: "string",
      label: "Bill Rate Frequency",
      description: "The frequency of the bill rate",
      optional: true,
      options: constants.RATE_FREQUENCIES,
    },
    isFullTime: {
      type: "boolean",
      label: "Is Full Time",
      description: "Whether this is a full-time placement",
      optional: true,
    },
    workQuantumNumber: {
      type: "integer",
      label: "Work Quantum Number",
      description: "The number of work units (e.g., `40` for 40 hours/week)",
      optional: true,
    },
    workQuantumUnit: {
      type: "string",
      label: "Work Quantum Unit",
      description: "The unit of work (e.g., `Hours`, `Days`)",
      optional: true,
    },
    workQuantumFrequency: {
      type: "string",
      label: "Work Quantum Frequency",
      description: "The frequency of work quantum (e.g., `Weekly`, `Monthly`)",
      optional: true,
    },
    contactIds: {
      type: "integer[]",
      label: "Contact IDs",
      description: "Array of contact IDs associated with this placement",
      optional: true,
    },
    noteId: {
      type: "integer",
      label: "Note ID",
      description: "The ID of a note to associate with this placement",
      optional: true,
    },
    revenueSplit: {
      type: "string[]",
      label: "Revenue Split",
      description: "Array of revenue split objects as JSON strings. Format: `[{\"user\": {\"id\": 1}, \"revenue\": {\"number\": 5000, \"pct\": 50}}]`",
      optional: true,
    },
    customFields: {
      type: "string[]",
      label: "Custom Fields",
      description: "Array of custom field objects as JSON strings. Format: `[{\"id\": 1, \"value\": \"...\"}]`",
      optional: true,
    },
  },
  annotations: {
    readOnlyHint: false,
    destructiveHint: false,
    openWorldHint: true,
    idempotentHint: false,
  },
  async run({ $ }) {
    const {
      app,
      userId,
      candidateId,
      jobId,
      jobStartDate,
      contractStartDate,
      contractEndDate,
      billingDate,
      salaryAmount,
      salaryCurrency,
      revenueAmount,
      revenueCurrency,
      successFeeAmount,
      successFeeCurrency,
      bonusAmount,
      bonusCurrency,
      payRateAmount,
      payRateCurrency,
      payRateFrequency,
      billRateAmount,
      billRateCurrency,
      billRateFrequency,
      isFullTime,
      workQuantumNumber,
      workQuantumUnit,
      workQuantumFrequency,
      contactIds,
      noteId,
      revenueSplit,
      customFields,
    } = this;

    const placement = {
      prospect: {
        id: candidateId,
      },
      job: {
        id: jobId,
      },
      job_start_date: jobStartDate,
    };

    // Add optional date fields
    if (contractStartDate) placement.contract_start_date = contractStartDate;
    if (contractEndDate) placement.contract_end_date = contractEndDate;
    if (billingDate) placement.billing_date = billingDate;

    // Add salary
    if (salaryAmount && salaryCurrency) {
      placement.salary = {
        number: salaryAmount,
        currency: salaryCurrency,
      };
    }

    // Add revenue
    if (revenueAmount && revenueCurrency) {
      placement.revenue = {
        number: revenueAmount,
        currency: revenueCurrency,
      };
    }

    // Add success fee
    if (successFeeAmount && successFeeCurrency) {
      placement.success_fee = {
        number: successFeeAmount,
        currency: successFeeCurrency,
      };
    }

    // Add bonus
    if (bonusAmount && bonusCurrency) {
      placement.bonus = {
        number: bonusAmount,
        currency: bonusCurrency,
      };
    }

    // Add pay rate
    if (payRateAmount && payRateCurrency) {
      placement.pay_rate = {
        number: payRateAmount,
        currency: payRateCurrency,
      };
      if (payRateFrequency) {
        placement.pay_rate.frequency = {
          name: payRateFrequency,
        };
      }
    }

    // Add bill rate
    if (billRateAmount && billRateCurrency) {
      placement.bill_rate = {
        number: billRateAmount,
        currency: billRateCurrency,
      };
      if (billRateFrequency) {
        placement.bill_rate.frequency = {
          name: billRateFrequency,
        };
      }
    }

    // Add work quantum
    if (isFullTime !== undefined || workQuantumNumber || workQuantumUnit || workQuantumFrequency) {
      placement.work_quantum = {};
      if (isFullTime !== undefined) placement.work_quantum.is_full_time = isFullTime;
      if (workQuantumNumber) placement.work_quantum.number = workQuantumNumber;
      if (workQuantumUnit) {
        placement.work_quantum.unit = {
          name: workQuantumUnit,
        };
      }
      if (workQuantumFrequency) {
        placement.work_quantum.frequency = {
          name: workQuantumFrequency,
        };
      }
    }

    // Add contacts
    if (contactIds && contactIds.length > 0) {
      placement.contacts = contactIds.map((id) => ({
        id,
      }));
    }

    // Add note
    if (noteId) placement.note = noteId;

    // Add revenue split
    if (revenueSplit && revenueSplit.length > 0) {
      placement.revenue_split = utils.parseJson(revenueSplit);
    }

    // Add custom fields
    if (customFields && customFields.length > 0) {
      placement.custom_fields = utils.parseJson(customFields);
    }

    const data = {
      user_id: userId,
      placements: [
        placement,
      ],
    };

    const response = await app.createPlacement({
      $,
      data,
    });

    $.export("$summary", "Successfully created placement record");
    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
Recruiterflow	`app`	`app`	This component uses the Recruiterflow app.
User ID	`userId`	`string`	Select a value from the drop down menu.
Candidate ID	`candidateId`	`string`	Select a value from the drop down menu.
Job ID	`jobId`	`string`	Select a value from the drop down menu.
Job Start Date	`jobStartDate`	`string`	The start date of the job (`YYYY-MM-DD` format, e.g., `2021-01-12`)
Contract Start Date	`contractStartDate`	`string`	The contract start date (`YYYY-MM-DD` format, e.g., `2021-01-12`)
Contract End Date	`contractEndDate`	`string`	The contract end date (`YYYY-MM-DD` format, e.g., `2021-01-12`)
Billing Date	`billingDate`	`string`	The billing date (`YYYY-MM-DD` format, e.g., `2021-01-12`)
Salary Amount	`salaryAmount`	`integer`	The salary amount
Salary Currency	`salaryCurrency`	`string`	The currency for the salary (e.g., `USD`, `EUR`, `GBP`)
Revenue Amount	`revenueAmount`	`integer`	The placement revenue/fee amount
Revenue Currency	`revenueCurrency`	`string`	The currency for the revenue (e.g., `USD`, `EUR`, `GBP`)
Success Fee Amount	`successFeeAmount`	`integer`	The success fee amount
Success Fee Currency	`successFeeCurrency`	`string`	The currency for the success fee
Bonus Amount	`bonusAmount`	`integer`	The bonus amount
Bonus Currency	`bonusCurrency`	`string`	The currency for the bonus
Pay Rate Amount	`payRateAmount`	`integer`	The pay rate amount
Pay Rate Currency	`payRateCurrency`	`string`	The currency for the pay rate
Pay Rate Frequency	`payRateFrequency`	`string`	Select a value from the drop down menu:`hourdayweekmonth`
Bill Rate Amount	`billRateAmount`	`integer`	The bill rate amount
Bill Rate Currency	`billRateCurrency`	`string`	The currency for the bill rate
Bill Rate Frequency	`billRateFrequency`	`string`	Select a value from the drop down menu:`hourdayweekmonth`
Is Full Time	`isFullTime`	`boolean`	Whether this is a full-time placement
Work Quantum Number	`workQuantumNumber`	`integer`	The number of work units (e.g., `40` for 40 hours/week)
Work Quantum Unit	`workQuantumUnit`	`string`	The unit of work (e.g., `Hours`, `Days`)
Work Quantum Frequency	`workQuantumFrequency`	`string`	The frequency of work quantum (e.g., `Weekly`, `Monthly`)
Contact IDs	`contactIds`	`integer[]`	Array of contact IDs associated with this placement
Note ID	`noteId`	`integer`	The ID of a note to associate with this placement
Revenue Split	`revenueSplit`	`string[]`	Array of revenue split objects as JSON strings. Format: `[{"user": {"id": 1}, "revenue": {"number": 5000, "pct": 50}}]`
Custom Fields	`customFields`	`string[]`	Array of custom field objects as JSON strings. Format: `[{"id": 1, "value": "..."}]`