Recruiterflow ACTION
Create Candidate
Creates a new candidate in Recruiterflow. See the documentation
- Action
- Writes data
- API key
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's Recruiterflow account once, then configure and run Create Candidate from your backend or agent.
import { PipedreamClient } from "@pipedream/sdk"
const pd = new PipedreamClient({
projectId: process.env.PIPEDREAM_PROJECT_ID!,
clientId: process.env.PIPEDREAM_CLIENT_ID!,
clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
projectEnvironment: "production",
})
const result = await pd.actions.run({
id: "recruiterflow-create-candidate",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
recruiterflow: { authProvisionId: "apn_xxxxxxx" },
name: "Name",
email: "Email",
},
})
console.log(result)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "recruiterflow-create-candidate",
"configured_props": {
"recruiterflow": { "authProvisionId": "apn_xxxxxxx" },
"name": "Name",
"email": "Email"
}
}'// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "recruiterflow",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
name: "recruiterflow-create-candidate",
arguments: {
name: "Name",
email: "Email",
},
})SCHEMA
Inputs
Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.
| Property | Type | Description |
|---|---|---|
name Name | string | Full name of the candidate Required |
email Email | string | Primary email address of the candidate Optional |
phoneNumber Phone Number | string | Primary phone number of the candidate Optional |
title Job Title | string | Current job title of the candidate Optional |
organization Organization | string | Current organization/company of the candidate Optional |
location Location | string | Location of the candidate (e.g., 'New York Metropolitan Area') Optional |
linkedinProfile LinkedIn Profile | string | LinkedIn profile URL Optional |
twitterProfile Twitter Profile | string | Twitter profile URL Optional |
facebookProfile Facebook Profile | string | Facebook profile URL Optional |
githubProfile GitHub Profile | string | GitHub profile URL Optional |
angellistProfile AngelList Profile | string | AngelList profile URL Optional |
source Source | string | Source of the candidate (e.g., 'linkedin', 'referral', 'website') Optional |
tags Tags | string[] | Tags to categorize the candidate Optional |
skills Skills | string[] | Array of candidate skills Optional |
leadOwnerId Lead Owner ID | string | ID of the user who will own this candidate Optional Dynamic |
experience Experience | string[] | Array of experience objects. Format: [{"organization": "Facebook", "designation": "SDE", "from": ["2", "2021"], "to": ["2", "2021"]}] Optional |
education Education | string[] | Array of education objects. Format: [{"school": "HPCA", "degree": "10th", "specialization": "MATHS", "from": ["5", "2021"], "to": ["5", "2022"]}] Optional |
customFields Custom Fields | string[] | Array of custom field objects. Example:
See the API documentation for more details. Optional |
addedTime Added Time | string | Timestamp for backdating candidate creation (ISO 8601 format, e.g., 2021-01-12T10:16:16+0000) Optional |
REFERENCE
Tool details
Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.
- Registry key
- recruiterflow-create-candidate
- Version
- 0.0.1
- App
- Recruiterflow
- Authentication
- API key
- Read-only
- No
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗