← Gem

Create Candidate with Gem API

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

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Create Candidate with the Gem API
No credit card required
Intro to Pipedream
Watch us build a workflow
Watch us build a workflow
8 min
Watch now ➜

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

Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo
Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo

Developers Pipedream

Getting Started

Create a workflow to Create Candidate with the Gem API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. 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
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Integrations

Create Candidate with Gem API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + Gem
 
Try it
Create Candidate with Gem API on New Submission from Typeform API
Typeform + Gem
 
Try it
Create Candidate with Gem API on New Submission (Instant) from Jotform API
Jotform + Gem
 
Try it
Create Candidate with Gem API on New Scheduled Tasks from Pipedream API
Pipedream + Gem
 
Try it
Create Candidate with Gem API on New Download Counts from npm API
npm + Gem
 
Try it

Details

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is 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.

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.1
Key:gem-create-candidate

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.1",
  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;
  },
};

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.
LabelPropTypeDescription
GemgemappThis component uses the Gem app.
Created BycreatedBystringSelect a value from the drop down menu.
First NamefirstNamestring

Candidate's first name

Last NamelastNamestring

Candidate's last name

Nicknamenicknamestring

Candidate's nickname

Primary Email AddressprimaryEmailstring

Candidate's primary email address

Email AddressesadditionalEmailsstring[]

List of candidate's additional email addresses

LinkedIn HandlelinkedInHandlestring

Enter your candidate's unique LinkedIn identifier (e.g., "satyanadella"). This helps the system check for duplicates before creating a new candidate entry.

Titletitlestring

Candidate's job title

Companycompanystring

Candidate's company name

Locationlocationstring

Candidate's location

Schoolschoolstring

Candidate's school

Education Info QuantityeducationInfoNumberinteger

The number of education info objects to be created

Work Info QuantityworkInfoNumberinteger

The number of work info objects to be created

Profile URLsprofileUrlsstring[]

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 NumberphoneNumberstring

Candidate's phone number

Project IDsprojectIdsstring[]Select a value from the drop down menu.
Custom FieldscustomFieldsobject

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 FromsourcedFromstringSelect a value from the drop down menu:SeekOuthireEZStarcircleCensiaConsider
Autofillautofillboolean

Requires Linked In Handle to be non-null. Attempts to fill in any missing fields.

Authentication

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

About Gem

The AI-Powered Recruiting Platform TA Teams Love

More Ways to Use Gem

Triggers

New Candidate Added from the Gem API

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

 
Try it

Explore Other Apps

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

HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
Node
Node
Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.
Python
Python
Anything you can do in Python can be done in a Pipedream Workflow. This includes using any of the 350,000+ PyPi packages available in your Python powered workflows.
Pipedream Utils
Pipedream Utils
Utility functions to use within your Pipedream workflows
OpenAI (ChatGPT)
OpenAI (ChatGPT)
OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular models like ChatGPT, DALL-E, and Whisper.
Premium
Salesforce
Salesforce
Web services API for interacting with Salesforce
Premium
HubSpot
HubSpot
HubSpot's CRM platform contains the marketing, sales, service, operations, and website-building software you need to grow your business.
Premium
Zoho CRM
Zoho CRM
Zoho CRM is an online Sales CRM software that manages your sales, marketing, and support in one CRM platform.
Premium
Stripe
Stripe
Stripe powers online and in-person payment processing and financial solutions for businesses of all sizes.
Shopify
Shopify
Shopify is a complete commerce platform that lets anyone start, manage, and grow a business. You can use Shopify to build an online store, manage sales, market to customers, and accept payments in digital and physical locations.
Premium
WooCommerce
WooCommerce
WooCommerce is the open-source ecommerce platform for WordPress.
Premium
Snowflake
Snowflake
A data warehouse built for the cloud
Premium
MongoDB
MongoDB
MongoDB is an open source NoSQL database management program.
Supabase
Supabase
Supabase is an open source Firebase alternative.
MySQL
MySQL
MySQL is an open-source relational database management system.
PostgreSQL
PostgreSQL
PostgreSQL is a free and open-source relational database management system emphasizing extensibility and SQL compliance.
Premium
AWS
AWS
Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.
Premium
Twilio SendGrid
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.
Amazon SES
Amazon SES
Amazon SES is a cloud-based email service provider that can integrate into any application for high volume email automation
Premium
Klaviyo
Klaviyo
Email Marketing and SMS Marketing Platform
Premium
Zendesk
Zendesk
Zendesk is award-winning customer service software trusted by 200K+ customers. Make customers happy via text, mobile, phone, email, live chat, social media.
Notion
Notion
Notion is a new tool that blends your everyday work apps into one. It's the all-in-one workspace for you and your team.
Slack
Slack
Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.
Microsoft Teams
Microsoft Teams
Microsoft Teams has communities, events, chats, channels, meetings, storage, tasks, and calendars in one place.