Create Candidate with Gem API on New Scheduled Tasks from Pipedream API

Pipedream makes it easy to connect APIs for Gem, Pipedream and 2,900+ other apps remarkably fast.

Trigger workflow on

New Scheduled Tasks from the Pipedream API

Next, do this

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

Select this integration
Configure the New Scheduled Tasks trigger
1. Connect your Pipedream account
2. Optional- Configure Secret
Configure the Create Candidate action
1. Connect your Gem account
2. Select a Created By
3. Optional- Configure First Name
4. Optional- Configure Last Name
5. Optional- Configure Nickname
6. Configure Primary Email Address
7. Optional- Configure Email Addresses
8. Optional- Configure LinkedIn Handle
9. Optional- Configure Title
10. Optional- Configure Company
11. Optional- Configure Location
12. Optional- Configure School
13. Optional- Configure Education Info Quantity
14. Optional- Configure Work Info Quantity
15. Optional- Configure Profile URLs
16. Optional- Configure Phone Number
17. Optional- Select one or more Project IDs
18. Optional- Configure Custom Fields
19. Optional- Select a Sourced From
20. Optional- Configure Autofill
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 Scheduled Tasks on Pipedream

Description:Exposes an HTTP API for scheduling messages to be emitted at a future time

Version:0.3.1

Key:pipedream-new-scheduled-tasks

View on GitHub

Pipedream Overview#

Pipedream is an API that allows you to build applications that can connect to
various data sources and processes them in real-time. You can use Pipedream to
create applications that can perform ETL (Extract, Transform, and Load) tasks,
as well as to create data-driven workflows.

Some examples of applications you can build using the Pipedream API include:

An application that can extract data from a database, transform it, and then
load it into another database.
An application that can monitor a data source for changes, and then trigger a
workflow in response to those changes.
An application that can poll an API for new data, and then process that data
in real-time.

Trigger Code#

import pipedream from "../../pipedream.app.mjs";
import sampleEmit from "./test-event.mjs";
import { uuid } from "uuidv4";

export default {
  key: "pipedream-new-scheduled-tasks",
  name: "New Scheduled Tasks",
  type: "source",
  description:
    "Exposes an HTTP API for scheduling messages to be emitted at a future time",
  version: "0.3.1",
  dedupe: "unique", // Dedupe on a UUID generated for every scheduled task
  props: {
    pipedream,
    secret: {
      type: "string",
      secret: true,
      label: "Secret",
      optional: true,
      description:
        "**Optional but recommended**: if you enter a secret here, you must pass this value in the `x-pd-secret` HTTP header when making requests",
    },
    http: {
      label: "Endpoint",
      description: "The endpoint where you'll send task scheduler requests",
      type: "$.interface.http",
      customResponse: true,
    },
    db: "$.service.db",
  },
  methods: {
    // To schedule future emits, we emit to the selfChannel of the component
    selfChannel() {
      return "self";
    },
    // Queue for future emits that haven't yet been delivered
    queuedEventsChannel() {
      return "$in";
    },
    httpRespond({
      status, body,
    }) {
      this.http.respond({
        headers: {
          "content-type": "application/json",
        },
        status,
        body,
      });
    },
    async selfSubscribe() {
      // Subscribe the component to itself. We do this here because even in
      // the activate hook, the component isn't available to take subscriptions.
      // Scheduled tasks are sent to the self channel, which emits the message at
      // the specified delivery_ts to this component.
      const isSubscribedToSelf = this.db.get("isSubscribedToSelf");
      if (!isSubscribedToSelf) {
        const componentId = process.env.PD_COMPONENT;
        const selfChannel = this.selfChannel();
        console.log(`Subscribing to ${selfChannel} channel for event source`);
        console.log(
          await this.pipedream.subscribe(componentId, componentId, selfChannel),
        );
        this.db.set("isSubscribedToSelf", true);
      }
    },
    validateEventBody(event, operation) {
      const errors = [];

      // Secrets are optional, so we first check if the user configured
      // a secret, then check its value against the prop (validation below)
      if (this.secret && event.headers["x-pd-secret"] !== this.secret) {
        errors.push(
          "Secret on incoming request doesn't match the configured secret",
        );
      }

      if (operation === "schedule") {
        const {
          timestamp,
          message,
        } = event.body;
        // timestamp should be an ISO 8601 string. Parse and check for validity below.
        const epoch = Date.parse(timestamp);

        if (!timestamp) {
          errors.push(
            "No timestamp included in payload. Please provide an ISO8601 timestamp in the 'timestamp' field",
          );
        }
        if (timestamp && !epoch) {
          errors.push("Timestamp isn't a valid ISO 8601 string");
        }
        if (!message) {
          errors.push("No message passed in payload");
        }
      }

      return errors;
    },
    scheduleTask(event) {
      const errors = this.validateEventBody(event, "schedule");
      let status, body;

      if (errors.length) {
        console.log(errors);
        status = 400;
        body = {
          errors,
        };
      } else {
        const id = this.emitScheduleEvent(event.body, event.body.timestamp);
        status = 200;
        body = {
          msg: "Successfully scheduled task",
          id,
        };
      }

      this.httpRespond({
        status,
        body,
      });
    },
    emitScheduleEvent(event, timestamp) {
      const selfChannel = this.selfChannel();
      const epoch = Date.parse(timestamp);
      const $id = uuid();

      console.log(`Scheduled event to emit on: ${new Date(epoch)}`);

      this.$emit(
        {
          ...event,
          $channel: selfChannel,
          $id,
        },
        {
          name: selfChannel,
          id: $id,
          delivery_ts: epoch,
        },
      );

      return $id;
    },
    async cancelTask(event) {
      const errors = this.validateEventBody(event, "cancel");
      let status, msg;

      if (errors.length) {
        console.log(errors);
        status = 400;
        msg = "Secret on incoming request doesn't match the configured secret";
      } else {
        try {
          const id = event.body.id;
          const isCanceled = await this.deleteEvent(event);
          if (isCanceled) {
            status = 200;
            msg = `Cancelled scheduled task for event ${id}`;
          } else {
            status = 404;
            msg = `No event with ${id} found`;
          }
        } catch (error) {
          console.log(error);
          status = 500;
          msg = "Failed to schedule task. Please see the logs";
        }
      }

      this.httpRespond({
        status,
        body: {
          msg,
        },
      });
    },
    async deleteEvent(event) {
      const componentId = process.env.PD_COMPONENT;
      const inChannel = this.queuedEventsChannel();

      // The user must pass a scheduled event UUID they'd like to cancel
      // We lookup the event by ID and delete it
      const { id } = event.body;

      // List events in the $in channel - the queue of scheduled events, to be emitted in the future
      const events = await this.pipedream.listEvents(
        componentId,
        inChannel,
      );
      console.log("Events: ", events);

      // Find the event in the list by id
      const eventToCancel = events.data.find((e) => {
        const { metadata } = e;
        return metadata.id === id;
      });

      console.log("Event to cancel: ", eventToCancel);

      if (!eventToCancel) {
        console.log(`No event with ${id} found`);
        return false;
      }

      // Delete the event
      await this.pipedream.deleteEvent(
        componentId,
        eventToCancel.id,
        inChannel,
      );
      return true;
    },
    emitEvent(event, summary) {
      // Delete the channel name and id from the incoming event, which were used only as metadata
      const id = event.$id;
      delete event.$channel;
      delete event.$id;

      this.$emit(event, {
        summary: summary ?? JSON.stringify(event),
        id,
        ts: +new Date(),
      });
    },
  },
  async run(event) {
    await this.selfSubscribe();

    const { path } = event;
    if (path === "/schedule") {
      this.scheduleTask(event);
    } else if (path === "/cancel") {
      await this.cancelTask(event);
    } else if (event.$channel === this.selfChannel()) {
      this.emitEvent(event);
    }
  },
  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
Pipedream	`pipedream`	`app`	This component uses the Pipedream app.
Secret	`secret`	`string`	Optional but recommended: if you enter a secret here, you must pass this value in the `x-pd-secret` HTTP header when making requests
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.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.

Trigger Authentication#

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

About Pipedream#

Integration platform for developers

Action#

Create Candidate on Gem

Description:Creates a new candidate in Gem. [See the documentation](https://api.gem.com/v0/reference#tag/Candidates/paths/~1v0~1candidates/post)

Version:0.0.2

Key:gem-create-candidate

View on GitHub

Action Code#

import { SOURCED_FROM } from "../../common/constants.mjs";
import { parseObject } from "../../common/utils.mjs";
import gem from "../../gem.app.mjs";

export default {
  key: "gem-create-candidate",
  name: "Create Candidate",
  description: "Creates a new candidate in Gem. [See the documentation](https://api.gem.com/v0/reference#tag/Candidates/paths/~1v0~1candidates/post)",
  version: "0.0.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    gem,
    createdBy: {
      propDefinition: [
        gem,
        "createdBy",
      ],
    },
    firstName: {
      type: "string",
      label: "First Name",
      description: "Candidate's first name",
      optional: true,
    },
    lastName: {
      type: "string",
      label: "Last Name",
      description: "Candidate's last name",
      optional: true,
    },
    nickname: {
      type: "string",
      label: "Nickname",
      description: "Candidate's nickname",
      optional: true,
    },
    primaryEmail: {
      type: "string",
      label: "Primary Email Address",
      description: "Candidate's primary email address",
    },
    additionalEmails: {
      type: "string[]",
      label: "Email Addresses",
      description: "List of candidate's additional email addresses",
      optional: true,
    },
    linkedInHandle: {
      type: "string",
      label: "LinkedIn Handle",
      description: "Enter your candidate's unique LinkedIn identifier (e.g., \"satyanadella\"). This helps the system check for duplicates before creating a new candidate entry.",
      optional: true,
    },
    title: {
      type: "string",
      label: "Title",
      description: "Candidate's job title",
      optional: true,
    },
    company: {
      type: "string",
      label: "Company",
      description: "Candidate's company name",
      optional: true,
    },
    location: {
      type: "string",
      label: "Location",
      description: "Candidate's location",
      optional: true,
    },
    school: {
      type: "string",
      label: "School",
      description: "Candidate's school",
      optional: true,
    },
    educationInfoNumber: {
      type: "integer",
      label: "Education Info Quantity",
      description: "The number of education info objects to be created",
      reloadProps: true,
      optional: true,
    },
    workInfoNumber: {
      type: "integer",
      label: "Work Info Quantity",
      description: "The number of work info objects to be created",
      reloadProps: true,
      optional: true,
    },
    profileUrls: {
      type: "string[]",
      label: "Profile URLs",
      description: "If `Profile URLs` is provided with an array of urls, social `profiles` will be generated based on the provided urls and attached to the candidate",
      optional: true,
    },
    phoneNumber: {
      type: "string",
      label: "Phone Number",
      description: "Candidate's phone number",
      optional: true,
    },
    projectIds: {
      propDefinition: [
        gem,
        "projectIds",
      ],
      optional: true,
    },
    customFields: {
      type: "object",
      label: "Custom Fields",
      description: "An object containing new custom field values. Only custom fields specified are updated. **Format: {\"custom_field_id\": \"value\"}**. [See the documentation](https://api.gem.com/v0/reference#tag/Candidates/paths/~1v0~1candidates/post) for further details.",
      optional: true,
    },
    sourcedFrom: {
      type: "string",
      label: "Sourced From",
      description: "Where the candidate was sourced from",
      options: SOURCED_FROM,
      optional: true,
    },
    autofill: {
      type: "boolean",
      label: "Autofill",
      description: "Requires `Linked In Handle` to be non-null. Attempts to fill in any missing fields.",
      optional: true,
    },
  },
  async additionalProps() {
    const props = {};
    if (this.educationInfoNumber) {
      for (let i = 1; i <= this.educationInfoNumber; i++) {
        props[`educationInfo${i}School`] = {
          type: "string",
          label: `Education Info ${i} - School`,
          description: `Education info ${i} school of the candidate`,
          optional: true,
        };
        props[`educationInfo${i}University`] = {
          type: "string",
          label: `Education Info ${i} - University`,
          description: `Education info ${i} university of the candidate`,
          optional: true,
        };
        props[`educationInfo${i}StartDate`] = {
          type: "string",
          label: `Education Info ${i} - Start Date`,
          description: `Education info ${i} start date of the candidate`,
          optional: true,
        };
        props[`educationInfo${i}EndDate`] = {
          type: "string",
          label: `Education Info ${i} - End Date`,
          description: `Education info ${i} end date of the candidate`,
          optional: true,
        };
        props[`educationInfo${i}FieldOfSchool`] = {
          type: "string",
          label: `Education Info ${i} - Field Of School`,
          description: `Education info ${i} field of school of the candidate`,
          optional: true,
        };
        props[`educationInfo${i}Major1`] = {
          type: "string",
          label: `Education Info ${i} - Major 1`,
          description: `Education info ${i} major 1 of the candidate`,
          optional: true,
        };
        props[`educationInfo${i}Major2`] = {
          type: "string",
          label: `Education Info ${i} - Major 2`,
          description: `Education info ${i} major 2 of the candidate`,
          optional: true,
        };
        props[`educationInfo${i}Degree`] = {
          type: "string",
          label: `Education Info ${i} - Degree`,
          description: `Education info ${i} degree of the candidate`,
          optional: true,
        };
      }
    }
    if (this.workInfoNumber) {
      for (let i = 1; i <= this.workInfoNumber; i++) {
        props[`WorkInfo${i}Company`] = {
          type: "string",
          label: `Work Info ${i} - Company`,
          description: `Work info ${i} company of the candidate`,
          optional: true,
        };
        props[`WorkInfo${i}Title`] = {
          type: "string",
          label: `Work Info ${i} - Title`,
          description: `Work info ${i} title of the candidate`,
          optional: true,
        };
        props[`WorkInfo${i}WorkStartDate`] = {
          type: "string",
          label: `Work Info ${i} - Work Start Date`,
          description: `Work info ${i} work start date of the candidate`,
          optional: true,
        };
        props[`WorkInfo${i}WorkEndDate`] = {
          type: "string",
          label: `Work Info ${i} - Work End Date`,
          description: `Work info ${i} work end date of the candidate`,
          optional: true,
        };
        props[`WorkInfo${i}IsCurrent`] = {
          type: "boolean",
          label: `Work Info ${i} - Is Current`,
          description: `Work info ${i} is Current of the candidate`,
          optional: true,
        };
      }
    }

    return props;
  },
  async run({ $ }) {
    const educationInfo = [];
    const workInfo = [];
    for (var i = 1; i <= this.educationInfoNumber; i++) {
      educationInfo.push({
        school: this[`educationInfo${i}School`],
        parsed_university: this[`educationInfo${i}University`],
        start_date: this[`educationInfo${i}StartDate`],
        end_date: this[`educationInfo${i}EndDate`],
        field_of_study: this[`educationInfo${i}FieldOfSchool`],
        parsed_major_1: this[`educationInfo${i}Major1`],
        parsed_major_2: this[`educationInfo${i}Major2`],
        degree: this[`educationInfo${i}Degree`],
      });
    }

    for (var j = 1; j <= this.workInfoNumber; j++) {
      workInfo.push({
        company: this[`WorkInfo${j}Company`],
        title: this[`WorkInfo${j}Title`],
        work_start_date: this[`WorkInfo${j}WorkStartDate`],
        work_end_date: this[`WorkInfo${j}WorkEndDate`],
        is_current: this[`WorkInfo${j}IsCurrent`],
      });
    }

    const emails = [
      {
        email_address: this.primaryEmail,
        is_primary: true,
      },
    ];
    if (this.additionalEmails) emails.push(...parseObject(this.additionalEmails).map((email) => ({
      email_address: email,
      is_primary: false,
    })));

    if (emails.length === 0) {
      throw new Error("Primary Email Address is required");
    }
    const candidate = await this.gem.createCandidate({
      $,
      data: {
        created_by: this.createdBy,
        first_name: this.firstName,
        last_name: this.lastName,
        nickname: this.nickname,
        emails,
        linked_in_handle: this.linkedInHandle,
        title: this.title,
        company: this.company,
        location: this.location,
        school: this.school,
        education_info: educationInfo,
        work_info: workInfo,
        profile_urls: parseObject(this.profileUrls),
        phone_number: this.phoneNumber,
        project_ids: parseObject(this.projectIds),
        custom_fields: Object.entries(parseObject(this.customFields))?.map(([
          key,
          value,
        ]) => ({
          custom_field_id: key,
          value,
        })),
        sourced_from: this.sourcedFrom,
        autofill: this.autofill,
      },
    });
    $.export(
      "$summary", `Created candidate ${candidate.first_name} ${candidate.last_name} with ID: ${candidate.id}`,
    );
    return candidate;
  },
};

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
Gem	`gem`	`app`	This component uses the Gem app.
Created By	`createdBy`	`string`	Select a value from the drop down menu.
First Name	`firstName`	`string`	Candidate's first name
Last Name	`lastName`	`string`	Candidate's last name
Nickname	`nickname`	`string`	Candidate's nickname
Primary Email Address	`primaryEmail`	`string`	Candidate's primary email address
Email Addresses	`additionalEmails`	`string[]`	List of candidate's additional email addresses
LinkedIn Handle	`linkedInHandle`	`string`	Enter your candidate's unique LinkedIn identifier (e.g., "satyanadella"). This helps the system check for duplicates before creating a new candidate entry.
Title	`title`	`string`	Candidate's job title
Company	`company`	`string`	Candidate's company name
Location	`location`	`string`	Candidate's location
School	`school`	`string`	Candidate's school
Education Info Quantity	`educationInfoNumber`	`integer`	The number of education info objects to be created
Work Info Quantity	`workInfoNumber`	`integer`	The number of work info objects to be created
Profile URLs	`profileUrls`	`string[]`	If `Profile URLs` is provided with an array of urls, social `profiles` will be generated based on the provided urls and attached to the candidate
Phone Number	`phoneNumber`	`string`	Candidate's phone number
Project IDs	`projectIds`	`string[]`	Select a value from the drop down menu.
Custom Fields	`customFields`	`object`	An object containing new custom field values. Only custom fields specified are updated. Format: {"custom_field_id": "value"}. See the documentation for further details.
Sourced From	`sourcedFrom`	`string`	Select a value from the drop down menu:`SeekOuthireEZStarcircleCensiaConsider`
Autofill	`autofill`	`boolean`	Requires `Linked In Handle` to be non-null. Attempts to fill in any missing fields.

Try it

Create a Subscription with Pipedream API on New Candidate Added from Gem API

Gem + Pipedream

Try it

Delete a Subscription with Pipedream API on New Candidate Added from Gem API

Gem + Pipedream

Try it

Get Component with Pipedream API on New Candidate Added from Gem API

Gem + Pipedream

Try it

Generate Component Code with Pipedream API on New Candidate Added from Gem API

Gem + Pipedream

Try it

Popular Triggers#

New Scheduled Tasks from the Pipedream API

Exposes an HTTP API for scheduling messages to be emitted at a future time

Try it

Card Due Date Reminder from the Pipedream API

Emit new event at a specified time before a card is due.

Try it

New Upcoming Calendar Event from the Pipedream API

Emit new event when a Calendar event is upcoming, this source is using reminderMinutesBeforeStart property of the event to determine the time it should emit.

Try it

New Candidate Added from the Gem API

Emit new event when a candidate is added in Gem. See the documentation

Try it