Async Payroll Imports and Pay Schedule Webhooks
This release makes payroll imports more scalable and gives integrators more visibility into pay schedule changes. Teams running larger payroll imports and partners building event-driven integrations benefit most.Highlights
- Asynchronous payroll import:
importRegularPayrollDataandimportDifferentialPayrollDatanow validate immediately and process accepted imports in the background. - Pay schedule webhooks: New events notify your systems when pay schedules are created or their status changes.
$0wage rate support: Payroll import and wage workflows now support employee wage rates of$0where applicable.
New Features
๐น Asynchronous payroll imports
importRegularPayrollData and importDifferentialPayrollData both support an asynchronous completion flow.
-
After request validation succeeds, the API returns a
Pendingresponse and continues applying payroll changes in the background instead of holding the request open until every payroll mutation finishes. -
During that import window, getPayPeriodDetails returns a
400response so clients do not display stale payroll data while the import is still being applied. -
When the import finishes, Rollfi sends the
payperiod.payperiodstatus.updatewebhook. That update does not introduce a new completion status. Instead, it restores the pay period to the same status you observed before the import began, while signaling that background import processing has completed.- For example, if the pay period was
newbefore the import started, the completion webhook will surface that pay period asnewagain. If it wascancelledbefore the import started, the completion webhook will surfacecancelledagain. In other words, the return to the prior visible pay period status is the signal that the async import window has closed and it is safe to re-fetch payroll details.
- For example, if the pay period was
-
When some employee-level mutations fail during async processing, the same
payperiod.payperiodstatus.updatewebhook can include a top-levelerrorobject summarizing those failures.
๐น Pay schedule webhook events
-
Your systems can now react automatically when pay schedules change. Two new webhook events are available:
payschedule.paysheduleisactive.insertโ sent when a pay schedule is created.payschedule.paysheduleisactive.updateโ sent when a pay scheduleโs status changes.
๐น Support for $0 wage rates
Rollfi now supports employee wage rates of $0. This allows clients to onboard employees with commission only wage structures who do not require differential pay.
โ ๏ธ Notes for Integrators
If you consume webhooks with retries enabled, remember that events may be delivered more than once. Continue to use idempotent processing.
Recommended Next Steps
- Update any
importRegularPayrollDataclient flow to handlePendingresponses. - Avoid rendering payroll details until
getPayPeriodDetailssucceeds after import completion. - Review the PaySchedule webhook overview if you build event-driven integrations that could benefit.
