← Recruiterflow

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

  1. 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
  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

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 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

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;
  },
};

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
RecruiterflowappappThis component uses the Recruiterflow app.
User IDuserIdstringSelect a value from the drop down menu.
Candidate IDcandidateIdstringSelect a value from the drop down menu.
Job IDjobIdstringSelect a value from the drop down menu.
Job Start DatejobStartDatestring

The start date of the job (YYYY-MM-DD format, e.g., 2021-01-12)

Contract Start DatecontractStartDatestring

The contract start date (YYYY-MM-DD format, e.g., 2021-01-12)

Contract End DatecontractEndDatestring

The contract end date (YYYY-MM-DD format, e.g., 2021-01-12)

Billing DatebillingDatestring

The billing date (YYYY-MM-DD format, e.g., 2021-01-12)

Salary AmountsalaryAmountinteger

The salary amount

Salary CurrencysalaryCurrencystring

The currency for the salary (e.g., USD, EUR, GBP)

Revenue AmountrevenueAmountinteger

The placement revenue/fee amount

Revenue CurrencyrevenueCurrencystring

The currency for the revenue (e.g., USD, EUR, GBP)

Success Fee AmountsuccessFeeAmountinteger

The success fee amount

Success Fee CurrencysuccessFeeCurrencystring

The currency for the success fee

Bonus AmountbonusAmountinteger

The bonus amount

Bonus CurrencybonusCurrencystring

The currency for the bonus

Pay Rate AmountpayRateAmountinteger

The pay rate amount

Pay Rate CurrencypayRateCurrencystring

The currency for the pay rate

Pay Rate FrequencypayRateFrequencystringSelect a value from the drop down menu:hourdayweekmonth
Bill Rate AmountbillRateAmountinteger

The bill rate amount

Bill Rate CurrencybillRateCurrencystring

The currency for the bill rate

Bill Rate FrequencybillRateFrequencystringSelect a value from the drop down menu:hourdayweekmonth
Is Full TimeisFullTimeboolean

Whether this is a full-time placement

Work Quantum NumberworkQuantumNumberinteger

The number of work units (e.g., 40 for 40 hours/week)

Work Quantum UnitworkQuantumUnitstring

The unit of work (e.g., Hours, Days)

Work Quantum FrequencyworkQuantumFrequencystring

The frequency of work quantum (e.g., Weekly, Monthly)

Contact IDscontactIdsinteger[]

Array of contact IDs associated with this placement

Note IDnoteIdinteger

The ID of a note to associate with this placement

Revenue SplitrevenueSplitstring[]

Array of revenue split objects as JSON strings. Format: [{"user": {"id": 1}, "revenue": {"number": 5000, "pct": 50}}]

Custom FieldscustomFieldsstring[]

Array of custom field objects as JSON strings. Format: [{"id": 1, "value": "..."}]

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.

About Recruiterflow

The Best ATS & CRM for Recruiting & Staffing Agencies.

More Ways to Use Recruiterflow

Actions

Add Candidate to Job with the Recruiterflow API

Associates a candidate with a job posting in Recruiterflow. See the documentation

 
Try it
Create Candidate with the Recruiterflow API

Creates a new candidate in Recruiterflow. See the documentation

 
Try it
Create Job with the Recruiterflow API

Creates a new job posting in Recruiterflow. See the documentation

 
Try it
Move Candidate to Stage with the Recruiterflow API

Moves a candidate to a different stage in the job pipeline. You can specify either stage ID or stage name. See the documentation

 
Try it
Search Candidates with the Recruiterflow API

Searches for candidates matching specified criteria in Recruiterflow. Supports both simple searches and advanced filter arrays. See the documentation

 
Try it

Explore Other Apps

1
-
24
of
3,000+
apps by most popular

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.
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.
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.
Anthropic (Claude)
Anthropic (Claude)
AI research and products that put safety at the frontier. Introducing Claude, a next-generation AI assistant for your tasks, no matter the scale.
Google Sheets
Google Sheets
Use Google Sheets to create and edit online spreadsheets. Get insights together with secure sharing in real-time and from any device.
Telegram
Telegram
Telegram, is a cloud-based, cross-platform, encrypted instant messaging (IM) service.
Google Drive
Google Drive
Google Drive is a file storage and synchronization service which allows you to create and share your work online, and access your documents from anywhere.
HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
Google Calendar
Google Calendar
With Google Calendar, you can quickly schedule meetings and events and get reminders about upcoming activities, so you always know what’s next.
Schedule
Schedule
Trigger workflows on an interval or cron schedule.
Pipedream Utils
Pipedream Utils
Utility functions to use within your Pipedream workflows
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.
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.
AWS
AWS
Premium
Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.
Twilio SendGrid
Twilio SendGrid
Premium
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
Klaviyo
Klaviyo
Premium
Klaviyo unifies your data, channels, and AI agents in one platform—text, WhatsApp, email marketing, and more—driving growth with every interaction.
Zendesk
Zendesk
Premium
Zendesk is award-winning customer service software trusted by 200K+ customers. Make customers happy via text, mobile, phone, email, live chat, social media.
ServiceNow
ServiceNow
Premium
Beta
The smarter way to workflow
Slack
Slack
Slack is the AI-powered platform for work bringing all of your conversations, apps, and customers together in one place. Around the world, Slack is helping businesses of all sizes grow and send productivity through the roof.
Microsoft Teams
Microsoft Teams
Microsoft Teams has communities, events, chats, channels, meetings, storage, tasks, and calendars in one place.