View as Markdown
Deputy icon

Deputy ACTION

Create Employee

Adds a new employee or staff member to the organization in Deputy. See the documentation
  • Action
  • Writes data
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Deputy 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: "deputy-create-employee",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    deputy: { 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
First name of the employee
Required
lastName Last Name string
Last name of the employee
Required
locationId Location ID string
The identifier of a location
Required Dynamic
dob Date of Birth string
The date of birth of the employee. Example: 1971-01-01
Optional
startDate Start Date string
The date that the employee started employment. Example: 1971-01-01
Optional
phone Phone string
Phone number of the employee
Optional
rate Rate string
The hourly rate 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
deputy-create-employee
Version
0.0.2
App
Deputy
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes