View as Markdown
Peakon Employee Voice icon

Peakon Employee Voice ACTION

Create Employee

Creates a new employee record in Peakon. Requires firstName, lastName, and identifier (the HR employee number, e.g. E001 — must be unique). Optional standard fields: email, employeeType (permanent/contractor/temporary/volunteer/other), employmentStatus. Custom HR attributes such as Department, Region, and Job Level can be set via customAttributes as a JSON object — e.g. {"Department": "Sales", "Region": "North America"}. Returns the new employee record including the internal id, which can be used with Update Employee or Delete Employee. See the Peakon API documentation
  • Action
  • Writes data
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Peakon Employee Voice 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: "peakon_employee_voice-create-employee",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    peakon_employee_voice: { 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
Employee's first name.
Required
lastName Last Name string
Employee's last name.
Required
identifier Identifier string
HR employee number or unique identifier (e.g. E001). Must be unique across employees.
Required
email Email string
Employee's work email address.
Optional
employeeType Employee Type string
Employment type.
Optional
employmentStatus Employment Status string
Current employment status (e.g. employed, on_leave).
Optional
customAttributes Custom Attributes string
JSON object of custom HR attributes for the employee. Example: {"Department": "Sales", "Region": "North America", "Job Level": "Manager"}. Enum values are accepted as plain strings.
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
peakon_employee_voice-create-employee
Version
0.0.2
App
Peakon Employee Voice
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes