Recruiterflow ACTION
Create Placement
Records a successful candidate placement 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 Placement 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-placement",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
recruiterflow: { authProvisionId: "apn_xxxxxxx" },
userId: "User ID",
candidateId: "Candidate ID",
},
})
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-placement",
"configured_props": {
"recruiterflow": { "authProvisionId": "apn_xxxxxxx" },
"userId": "User ID",
"candidateId": "Candidate ID"
}
}'// 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-placement",
arguments: {
userId: "User ID",
candidateId: "Candidate ID",
},
})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 |
|---|---|---|
userId User ID | string | The ID of the user creating the placement Required Dynamic |
candidateId Candidate ID | string | The ID of the candidate being placed Required Dynamic |
jobId Job ID | string | The ID of the job for this placement Required Dynamic |
jobStartDate Job Start Date | string | The start date of the job ( YYYY-MM-DD format, e.g., 2021-01-12) Required |
contractStartDate Contract Start Date | string | The contract start date ( YYYY-MM-DD format, e.g., 2021-01-12) Optional |
contractEndDate Contract End Date | string | The contract end date ( YYYY-MM-DD format, e.g., 2021-01-12) Optional |
billingDate Billing Date | string | The billing date ( YYYY-MM-DD format, e.g., 2021-01-12) Required |
salaryAmount Salary Amount | integer | The salary amount Optional |
salaryCurrency Salary Currency | string | The currency for the salary (e.g., USD, EUR, GBP) Optional |
revenueAmount Revenue Amount | integer | The placement revenue/fee amount Optional |
revenueCurrency Revenue Currency | string | The currency for the revenue (e.g., USD, EUR, GBP) Optional |
successFeeAmount Success Fee Amount | integer | The success fee amount Optional |
successFeeCurrency Success Fee Currency | string | The currency for the success fee Optional |
bonusAmount Bonus Amount | integer | The bonus amount Optional |
bonusCurrency Bonus Currency | string | The currency for the bonus Optional |
payRateAmount Pay Rate Amount | integer | The pay rate amount Optional |
payRateCurrency Pay Rate Currency | string | The currency for the pay rate Optional |
payRateFrequency Pay Rate Frequency | string | The frequency of the pay rate Optional |
billRateAmount Bill Rate Amount | integer | The bill rate amount Optional |
billRateCurrency Bill Rate Currency | string | The currency for the bill rate Optional |
billRateFrequency Bill Rate Frequency | string | The frequency of the bill rate Optional |
isFullTime Is Full Time | boolean | Whether this is a full-time placement Optional |
workQuantumNumber Work Quantum Number | integer | The number of work units (e.g., 40 for 40 hours/week) Optional |
workQuantumUnit Work Quantum Unit | string | The unit of work (e.g., Hours, Days) Optional |
workQuantumFrequency Work Quantum Frequency | string | The frequency of work quantum (e.g., Weekly, Monthly) Optional |
contactIds Contact IDs | integer[] | Array of contact IDs associated with this placement Optional |
noteId Note ID | integer | The ID of a note to associate with this placement Optional |
revenueSplit Revenue Split | string[] | Array of revenue split objects as JSON strings. Format: [{"user": {"id": 1}, "revenue": {"number": 5000, "pct": 50}}] Optional |
customFields Custom Fields | string[] | Array of custom field objects as JSON strings. Format: [{"id": 1, "value": "..."}] 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-placement
- Version
- 0.0.1
- App
- Recruiterflow
- Authentication
- API key
- Read-only
- No
- Destructive
- No
- Idempotent
- No
- Open world
- Yes
- Source
- View on GitHub ↗