Schedule Offboarding
To schedule a worker for offboarding, provide an exit date and reason. You can optionally adjust their compensation for the exit period.- With Compensation
- Without Compensation
Request Fields
| Field | Type | Required | Description |
|---|---|---|---|
exitDate | string (date) | Yes | The date the person will exit the organization (YYYY-MM-DD) |
reason | string | Yes | The reason for offboarding |
compensation | object | No | Adjusted compensation for the exit period (uses the same compInfo schema as onboarding). Omit to keep current compensation unchanged. If provided, proration for partial periods is your responsibility. |
includeInRegularPayroll | boolean | No | Whether to include the person in the regular payroll run for their exit period |
Cancel Offboarding
Cancel a pending offboarding if the decision is reversed or it was scheduled in error. This returns the person to Active status.The person must be in Offboarding status. Cancelling offboarding for a person who is already Former or Active returns a
400 error.Reinstate a Worker
To bring a former worker back to active status — for example, a rehire or a reversal — use the reinstate endpoint.The person must be in Former status. Reinstating a person who is still Active or Offboarding returns a
400 error.Offboarding Lifecycle
The diagram below shows how a person’s status transitions through the offboarding process.Offboarding completes automatically on the day after the exit date. For example, if the exit date is June 30, the person’s status changes to Former on July 1.
Webhook Events
Cadana delivers webhook events for each offboarding lifecycle transition. Subscribe to these via the Webhooks configuration.| Event | Fired when | Payload |
|---|---|---|
person.offboarding.scheduled | Offboarding is scheduled | exitDate, reason |
person.offboarding.cancelled | Pending offboarding is cancelled | Person ID only |
person.offboarding.completed | Person transitions to Former | exitDate, reason |
person.reinstated | Former person is reinstated to Active | Person ID only |
Notifications
When offboarding is scheduled, Cadana sends an offboarding scheduled email notification to the person, informing them of their exit date.Offboarding Details in GET Response
While a person is in Offboarding status, theGET /v1/persons/{personId} response includes an offboardingDetails object with the scheduled offboarding information.
| Field | Type | Description |
|---|---|---|
exitDate | string (date) | The scheduled exit date |
reason | string | The reason for offboarding |
compensation | object | Adjusted compensation for the exit period, if provided |
includeInRegularPayroll | boolean | Whether the person is included in the regular payroll run |
The
offboardingDetails field is only present while the person is in Offboarding status. Once they transition to Former or are cancelled back to Active, this field is no longer included in the response.