Personnel Event API¶
The Personnel Event API allows you to create Personnel Events in Permission Assist from external systems. Instead of logging in to the Permission Assist web interface to manually create an event, your HRIS platform, ticketing system, or automation tool calls the API and Permission Assist creates the event automatically.
How it works¶
When you create a Personnel Event through the API, Permission Assist does the following:
- Validates your request — Permission Assist checks your API credentials and validates the event data you provided.
- Creates the Personnel Event — Permission Assist creates the event using the same internal process as a manually created event. The event enters the normal Personnel Event workflow.
- Returns a confirmation — The API returns the identifier for the created event so your system can track it.
- Records the audit trail — The event maintains the same compliance documentation as a manually created event. The audit trail captures the API caller identity.
After the event is created, it follows the same workflow as any other Personnel Event. Downstream processing — including workflow automation and Access Model assignment — uses existing Permission Assist functionality.
Supported event types¶
The Personnel Event API supports four event types, each with its own endpoint:
Note
Onboarding events accept identity metadata (name, department, title,
and so on) because the identity does not yet exist in Permission Assist.
All other event types require the identityId of an existing identity.
| Event type | Endpoint | Description |
|---|---|---|
| Onboarding | POST /api/personnel-events/onboard |
A new employee is joining the organization and needs access provisioned |
| Offboarding | POST /api/personnel-events/offboard |
An employee is leaving and needs access deprovisioned |
| Role Transition/Position Change | POST /api/personnel-events/role-transition |
An employee is changing roles and needs access adjusted |
| Leave of Absence | POST /api/personnel-events/leave-of-absence |
An employee is going on leave and may need access suspended |
Each event type requires different data fields and has a dedicated endpoint. Refer to Create a Personnel Event for the specific fields required for each type, or see the API Reference for the complete request schema.
Common use cases¶
Organizations typically use the Personnel Event API for workflows like these:
- HRIS integration — When a new hire is entered in the HRIS system, a middleware layer or automation script creates an Onboarding event in Permission Assist. By the employee's start date, access is already provisioned.
- Same-day terminations — When an employee separation is recorded in the HRIS or ticketing system, an Offboarding event is created immediately, eliminating the delay between the HR action and the start of deprovisioning.
- Self-service role changes — A manager submits a role change through a self-service portal. The portal calls the Permission Assist API to create a Role Transition/Position Change event, which starts the access adjustment workflow.
Next steps¶
- Create a Personnel Event — Step-by-step instructions for each event type
- API Reference — Technical details for all endpoints, including creating, listing, and retrieving Personnel Events