v1

latestOpenAPI 3.1.02026-07-26294215839.4 KB

Onboarding

Public API

Create employee onboarding experience

Creates (starts) an onboarding experience workflow for the employee’s existing new hire packet instance. Requires the onboarding experience phase-1 and workflow framework company toggles. Optional sentDateTime may be supplied for workflow idempotency (ISO 8601 or legacy datetime string accepted when non-empty).

OAuth Scopes: onboarding.write

post/api/v1/employees/{employeeId}/onboarding-experiences

Path parameters

employeeIdinteger required

Request body

sentDateTimestring nullable

Optional sent datetime for the packet when starting the experience (string).

Response

Created

idinteger

Onboarding experience id (same as the new hire packet instance primary key).

employeeIdinteger

Employee this onboarding experience belongs to.

newHirePacketIdinteger

Primary key of the linked new hire packet instance (NHP row).

nhpTemplateIdinteger nullable

Linked NHP template id, if any.

nhpConfigurationIdinteger nullable

Linked NHP configuration id, if any.

status'cancelled' | 'completed' | 'sent' | 'draft'

Derived lifecycle status for the linked new hire packet instance.