View as Markdown
TalentHR icon

TalentHR ACTION

Create Employee

Hires a new employee and registers them in the system. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's TalentHR 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: "talenthr-create-employee",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    talenthr: { 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 first name of the new employee
Required
lastName Last Name string
The last name of the new employee
Required
email Email string
The email address of the new employee
Required
hireDate Hire Date string
The date of the new employee's hire. Format YYYY-MM-DD
Required
employmentStatusId Employment Status ID string
The employment status ID
Required Dynamic
reportsToEmployeeId Employee ID string
The ID of the employee
Optional Dynamic
jobTitleId Job Title ID string
The ID of the job title.
Optional Dynamic
jobLocationId Job Location ID string
The ID of the job location.
Optional Dynamic
divisionId Division ID string
The division for which the application has been submitted
Optional Dynamic
departmentId Department ID string
The department for which the application has been submitted
Optional Dynamic
payRate Pay Rate string
Employee's wage and must have 2 decimals. E.g 1255.38
Required
payRatePeriod Pay Rate Period string
The period over which money is earned.
Required
payRateSchedule Pay Rate Schedule string
Frequency of the wage.
Optional
overtimeStatus Overtime Status string
Determining whether an employee is exempt or non-exempt from overtime regulations.
Optional
preventEmail Prevent Email boolean
Opt for 'true', if you don't want to send an invitation email to the hiring employee, else 'false'.
Optional
isExisting Is Existing boolean
Opt for 'false' if the employee is a new hire and you want to run the Automatic Onboarding process, else 'true'.
Optional
whoId Who ID integer
The employee who will meet the newly hired employee. Required if When Time and address is present.
Optional
address Address string
The address where the meeting will take place. Required if Who ID and When Time is present.
Optional
whenTime When Time string
The date time that the meeting will take place. Required if Who ID and address is present. The hire date must be formatted as 'YYYY-MM-DD HH:II'.
Optional
instructions Instructions string
Important Instructions for the newly hired 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
talenthr-create-employee
Version
0.0.3
App
TalentHR
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes