View as Markdown
Peakon Employee Voice icon

Peakon Employee Voice ACTION

Update Employee

Partially updates an existing employee's attributes using their internal ID. Only the fields you provide will be updated — omitted fields are left unchanged. Use List Employees to find the employee's id first. Standard fields: firstName, lastName, identifier, employmentStatus. Custom HR attributes (Department, Region, Job Level, etc.) can be updated via customAttributes as a JSON object — e.g. {"Department": "Engineering"}. Enum attribute values are accepted as plain strings; Peakon resolves option IDs internally. 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 Update 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-update-employee",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    peakon_employee_voice: { authProvisionId: "apn_xxxxxxx" },
    employeeId: "Employee ID",
    firstName: "First 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.

Update Employee inputs
Property Type Description
employeeId Employee ID string
Internal Peakon employee ID (e.g. 80166956). Use List Employees to find the ID by searching by name.
Required
firstName First Name string
Employee's first name.
Optional
lastName Last Name string
Employee's last name.
Optional
identifier Identifier string
HR employee number or unique identifier (e.g. E001). Must be unique across employees.
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-update-employee
Version
0.0.2
App
Peakon Employee Voice
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes