Create Candidate with Recruiterflow API

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

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Create Candidate 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#

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

Configure the Create Candidate action
1. Connect your Recruiterflow account
2. Configure Name
3. Optional- Configure Email
4. Optional- Configure Phone Number
5. Optional- Configure Job Title
6. Optional- Configure Organization
7. Optional- Configure Location
8. Optional- Configure LinkedIn Profile
9. Optional- Configure Twitter Profile
10. Optional- Configure Facebook Profile
11. Optional- Configure GitHub Profile
12. Optional- Configure AngelList Profile
13. Optional- Configure Source
14. Optional- Configure Tags
15. Optional- Configure Skills
16. Optional- Select a Lead Owner ID
17. Optional- Configure Experience
18. Optional- Configure Education
19. Optional- Configure Custom Fields
20. Optional- Configure Added Time
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

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 Recruiterflow

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

Version:0.0.1

Key:recruiterflow-create-candidate

View on GitHub

Code#

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

export default {
  key: "recruiterflow-create-candidate",
  name: "Create Candidate",
  description: "Creates a new candidate in Recruiterflow. [See the documentation](https://recruiterflow.com/swagger.yml)",
  version: "0.0.1",
  type: "action",
  annotations: {
    readOnlyHint: false,
    destructiveHint: false,
    openWorldHint: true,
  },
  props: {
    app,
    name: {
      type: "string",
      label: "Name",
      description: "Full name of the candidate",
    },
    email: {
      type: "string",
      label: "Email",
      description: "Primary email address of the candidate",
      optional: true,
    },
    phoneNumber: {
      type: "string",
      label: "Phone Number",
      description: "Primary phone number of the candidate",
      optional: true,
    },
    title: {
      type: "string",
      label: "Job Title",
      description: "Current job title of the candidate",
      optional: true,
    },
    organization: {
      type: "string",
      label: "Organization",
      description: "Current organization/company of the candidate",
      optional: true,
    },
    location: {
      type: "string",
      label: "Location",
      description: "Location of the candidate (e.g., 'New York Metropolitan Area')",
      optional: true,
    },
    linkedinProfile: {
      type: "string",
      label: "LinkedIn Profile",
      description: "LinkedIn profile URL",
      optional: true,
    },
    twitterProfile: {
      type: "string",
      label: "Twitter Profile",
      description: "Twitter profile URL",
      optional: true,
    },
    facebookProfile: {
      type: "string",
      label: "Facebook Profile",
      description: "Facebook profile URL",
      optional: true,
    },
    githubProfile: {
      type: "string",
      label: "GitHub Profile",
      description: "GitHub profile URL",
      optional: true,
    },
    angellistProfile: {
      type: "string",
      label: "AngelList Profile",
      description: "AngelList profile URL",
      optional: true,
    },
    source: {
      type: "string",
      label: "Source",
      description: "Source of the candidate (e.g., 'linkedin', 'referral', 'website')",
      optional: true,
    },
    tags: {
      type: "string[]",
      label: "Tags",
      description: "Tags to categorize the candidate",
      optional: true,
    },
    skills: {
      type: "string[]",
      label: "Skills",
      description: "Array of candidate skills",
      optional: true,
    },
    leadOwnerId: {
      propDefinition: [
        app,
        "userId",
      ],
      label: "Lead Owner ID",
      description: "ID of the user who will own this candidate",
      optional: true,
    },
    experience: {
      type: "string[]",
      label: "Experience",
      description: "Array of experience objects. Format: `[{\"organization\": \"Facebook\", \"designation\": \"SDE\", \"from\": [\"2\", \"2021\"], \"to\": [\"2\", \"2021\"]}]`",
      optional: true,
    },
    education: {
      type: "string[]",
      label: "Education",
      description: "Array of education objects. Format: `[{\"school\": \"HPCA\", \"degree\": \"10th\", \"specialization\": \"MATHS\", \"from\": [\"5\", \"2021\"], \"to\": [\"5\", \"2022\"]}]`",
      optional: true,
    },
    customFields: {
      propDefinition: [
        app,
        "customFields",
      ],
    },
    addedTime: {
      type: "string",
      label: "Added Time",
      description: "Timestamp for backdating candidate creation (ISO 8601 format, e.g., `2021-01-12T10:16:16+0000`)",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      app,
      name,
      email,
      phoneNumber,
      title,
      organization,
      location,
      linkedinProfile,
      twitterProfile,
      facebookProfile,
      githubProfile,
      angellistProfile,
      source,
      tags,
      skills,
      leadOwnerId,
      experience,
      education,
      customFields,
      addedTime,
    } = this;

    const response = await app.createCandidate({
      $,
      data: {
        name,
        email,
        phone_number: phoneNumber,
        title,
        organization,
        ...(location
          ? {
            location: {
              location,
            },
          }
          : undefined
        ),
        linkedin_profile: linkedinProfile,
        twitter_profile: twitterProfile,
        facebook_profile: facebookProfile,
        github_profile: githubProfile,
        angellist_profile: angellistProfile,
        source,
        tags,
        skills,
        lead_owner_id: leadOwnerId,
        experience: utils.parseJson(experience),
        education: utils.parseJson(education),
        custom_fields: utils.parseJson(customFields),
        added_time: addedTime,
      },
    });

    $.export("$summary", `Successfully created candidate: ${name}`);
    return response;
  },
};

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
Recruiterflow	`app`	`app`	This component uses the Recruiterflow app.
Name	`name`	`string`	Full name of the candidate
Email	`email`	`string`	Primary email address of the candidate
Phone Number	`phoneNumber`	`string`	Primary phone number of the candidate
Job Title	`title`	`string`	Current job title of the candidate
Organization	`organization`	`string`	Current organization/company of the candidate
Location	`location`	`string`	Location of the candidate (e.g., 'New York Metropolitan Area')
LinkedIn Profile	`linkedinProfile`	`string`	LinkedIn profile URL
Twitter Profile	`twitterProfile`	`string`	Twitter profile URL
Facebook Profile	`facebookProfile`	`string`	Facebook profile URL
GitHub Profile	`githubProfile`	`string`	GitHub profile URL
AngelList Profile	`angellistProfile`	`string`	AngelList profile URL
Source	`source`	`string`	Source of the candidate (e.g., 'linkedin', 'referral', 'website')
Tags	`tags`	`string[]`	Tags to categorize the candidate
Skills	`skills`	`string[]`	Array of candidate skills
Lead Owner ID	`leadOwnerId`	`string`	Select a value from the drop down menu.
Experience	`experience`	`string[]`	Array of experience objects. Format: `[{"organization": "Facebook", "designation": "SDE", "from": ["2", "2021"], "to": ["2", "2021"]}]`
Education	`education`	`string[]`	Array of education objects. Format: `[{"school": "HPCA", "degree": "10th", "specialization": "MATHS", "from": ["5", "2021"], "to": ["5", "2022"]}]`
Custom Fields	`customFields`	`string[]`	Array of custom field objects. Example: `[ { "id": 16, "value": {"currency": "USD", "number": 600000} }, { "id": 17, "value": {"currency": "USD", "number1": 600000, "number2": 800000} }, { "id": 19, "value": {"number1": 600000, "number2": 800000} }, { "id": 20, "value": ["choice1", "choice2"] }, { "id" : 33, "value" : "Random" } ]` See the API documentation for more details.
Added Time	`addedTime`	`string`	Timestamp for backdating candidate creation (ISO 8601 format, e.g., `2021-01-12T10:16:16+0000`)

Authentication#

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