View as Markdown
HR Cloud icon

HR Cloud ACTION

Create Employee

Create a new employee record in the system. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's HR Cloud account once, then configure and run Create Employee 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: "hr_cloud-create-employee",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    hr_cloud: { authProvisionId: "apn_xxxxxxx" },
    firstName: "First Name",
    lastName: "Last Name",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Create Employee inputs
Property Type Description
firstName First Name string
The employee's first name
Required
lastName Last Name string
The employee's last name
Required
email Email string
The employee's email address
Required
jobTitle Job Title string
The ID of a job title
Required Dynamic
departmentId Department string
The ID of an employee department
Required Dynamic
startDate Start Date string
The employee's start date (YYYY-MM-DD)
Required
locationId Location ID string
The ID of a location
Required Dynamic
employmentStatus Employment Status ID string
The ID of an employment status
Required Dynamic
employeeNumber Employee Number string
Unique employee number
Optional
recordStatus Record Status string
The employee status
Optional
address Street Address string
The street address of the employee
Optional
city City string
The city of the employee
Optional
state State string
The state of the employee
Optional
zip Zip integer
The zip code of the employee
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
hr_cloud-create-employee
Version
0.0.2
App
HR Cloud
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes