Move Candidate to Stage 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

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

Configure the Move Candidate to Stage action
1. Connect your Recruiterflow account
2. Select a Candidate ID
3. Optional- Configure Stage ID
4. Optional- Select a Stage Name
5. Optional- Select a Job ID
6. Select a User ID
7. 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.

Move Candidate to Stage on Recruiterflow

Description:Moves a candidate to a different stage in the job pipeline. You can specify either stage ID or stage name. [See the documentation](https://recruiterflow.com/swagger.yml)

Version:0.0.1

Key:recruiterflow-move-candidate-to-stage

View on GitHub

Code#

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

export default {
  key: "recruiterflow-move-candidate-to-stage",
  name: "Move Candidate to Stage",
  description: "Moves a candidate to a different stage in the job pipeline. You can specify either stage ID or stage name. [See the documentation](https://recruiterflow.com/swagger.yml)",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    candidateId: {
      propDefinition: [
        app,
        "candidateId",
      ],
      label: "Candidate ID",
      description: "The ID of the candidate to move",
    },
    stageId: {
      type: "integer",
      label: "Stage ID",
      description: "The ID of the destination stage. Use this OR Stage Name (not both).",
      optional: true,
    },
    stageName: {
      type: "string",
      label: "Stage Name",
      description: "The name of the destination stage (e.g., 'Applied', 'Screening', 'Interview', 'Offer', 'Hired'). Use this OR Stage ID (not both). If using stage name, Job ID is required.",
      optional: true,
      options: [
        "Applied",
        "Screening",
        "Interview",
        "Offer",
        "Hired",
      ],
    },
    jobId: {
      propDefinition: [
        app,
        "jobId",
      ],
      label: "Job ID",
      description: "The ID of the job. Required only when using Stage Name instead of Stage ID.",
      optional: true,
    },
    userId: {
      propDefinition: [
        app,
        "userId",
      ],
      label: "User ID",
      description: "The ID of the user moving the candidate",
    },
    addedTime: {
      type: "string",
      label: "Added Time",
      description: "Timestamp for backdating when the candidate was moved to the stage (ISO 8601 format, e.g., '2021-01-12T10:16:16+0000')",
      optional: true,
    },
  },
  annotations: {
    readOnlyHint: false,
    destructiveHint: false,
    openWorldHint: true,
  },
  async run({ $ }) {
    const {
      app,
      candidateId,
      stageId,
      stageName,
      jobId,
      userId,
      addedTime,
    } = this;

    // Validate that either stageId or stageName is provided
    if (!stageId && !stageName) {
      throw new Error("Either Stage ID or Stage Name must be provided");
    }

    if (stageId && stageName) {
      throw new Error("Provide either Stage ID or Stage Name, not both");
    }

    // Validate that jobId is provided when using stageName
    if (stageName && !jobId) {
      throw new Error("Job ID is required when using Stage Name");
    }

    const data = {
      id: candidateId,
      stage: {},
    };

    // Set stage by ID or name
    if (stageId) {
      data.stage.id = stageId;
    } else {
      data.stage.name = stageName;
      data.job_id = jobId;
    }

    if (userId) {
      data.user_id = userId;
    }

    if (addedTime) {
      data.added_time = addedTime;
    }

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

    const stageDescription = stageId
      ? `stage ID ${stageId}`
      : `stage ${stageName}`;
    $.export("$summary", `Successfully moved candidate to ${stageDescription}`);
    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.
Candidate ID	`candidateId`	`string`	Select a value from the drop down menu.
Stage ID	`stageId`	`integer`	The ID of the destination stage. Use this OR Stage Name (not both).
Stage Name	`stageName`	`string`	Select a value from the drop down menu:`AppliedScreeningInterviewOfferHired`
Job ID	`jobId`	`string`	Select a value from the drop down menu.
User ID	`userId`	`string`	Select a value from the drop down menu.
Added Time	`addedTime`	`string`	Timestamp for backdating when the candidate was moved to the stage (ISO 8601 format, e.g., '2021-01-12T10:16:16+0000')