Jump to Content
Documentation
Reference
Log In
Reference
Log In
Documentation
Reference
Worker.created
All
Pages
Start typing to search…
JUMP TO
Overview
Reference Overview
REST API
Authentication
Create User API token
post
Documents
Retrieve Document
get
Generate document link
post
Employers
Retrieve Employers
get
Create Employer
post
Delete Employer
del
Retrieve Employer
get
Update Employer
put
Retrieve EmployerContactMethods
get
Retrieve an EmployerContactMethod
get
Retrieve all worker terminations of an employer
get
Accept or reject Employer Terms of Service
post
Employer Account Standing
Retrieve employer account standing
get
Employer Capabilities
Retrieve employer capabilities
get
Benefit
Retrieve all EmployerBenefitTypes
get
Create EmployerBenefitType
post
Delete EmployerBenefitType
del
Retrieve a single EmployerBenefitType
get
Update EmployerBenefitType
patch
Retrieve all PartnerBenefitTypes
get
Retrieve a single PartnerBenefitType
get
Pay
Retrieve all EmployerPayTypes
get
Create EmployerPayType
post
Delete EmployerPayType
del
Retrieve a single EmployerPayType
get
Update EmployerPayType
patch
Retrieve all PartnerPayTypes
get
Retrieve a single PartnerPayType
get
Time Off
Retrieve all EmployerTimeOffTypes
get
Create EmployerTimeOffType
post
Delete EmployerTimeOffType
del
Retrieve a single EmployerTimeOffType
get
Update EmployerTimeOffType
patch
Retrieve all PartnerTimeOffTypes
get
Retrieves a single PartnerTimeOffType
get
Mock Onboarding
Mock-onboard Employer
post
Mock-onboard Worker
post
Employer Onboarding
Retrieve list of HostedEmployerOnboarding
get
Create HostedEmployerOnboarding
post
Retrieve HostedEmployerOnboarding
get
Payroll Runs
Retrieve all PayrollRuns
get
Create PayrollRun
post
Preview PayrollRun
post
Delete PayrollRun
del
Retrieve PayrollRun
get
Confirm PayrollRun
post
Retrieve PayrollRun state
get
Retrieve all WorkerPaymentRecords
get
Modify a WorkerPayment
patch
Payroll Run Reports
Cash Requirements report
get
Payroll Journal report
get
Period Preview
Preview a period
post
Employer Reports
Payroll Journal report
post
Employer Signatories
Retrieve all Employer Signatories
get
Create a new Employer Signatory
post
Retrieve an Employer Signatory
get
Update an Employer Signatory
put
Employer Work Location
Retrieve work locations.
get
Retrieve a work location.
get
Work Weeks
Retrieve all EmployerWorkWeeks
get
Create EmployerWorkWeek
post
Delete EmployerWorkWeek
del
Retrieve EmployerWorkWeek
get
Update EmployerWorkWeek
patch
Worker Pay Groups
Retrieve all WorkerPayGroups
get
Create WorkerPayGroup
post
Delete WorkerPayGroup
del
Retrieve WorkerPayGroup
get
Update WorkerPayGroup
put
Worker Payments
Delete WorkerPayment
del
Retrieve WorkerPayment
get
Advance Payment
post
Get compensations
get
Creates compensation
put
Confirm WorkerPayment
post
Get deductions
get
Creates deduction
put
Get pay
get
Creates or updates pay for a particular worker payment
put
Get WorkerPaymentRecord
get
Retrieve WorkerPayments
get
Create WorkerPayment
post
Workers
Retrieve Workers
get
Create Worker
post
Delete Worker
del
Retrieve Worker
get
Update Worker
put
Worker Capabilities
Retrieve worker capabilities
get
Worker Contract
Retrieve WorkerContracts
get
Create WorkerContract
post
Update WorkerContract
patch
Worker Onboarding
Retrieve list of HostedWorkerOnboarding
get
Create HostedWorkerOnboarding
post
Retrieve HostedWorkerOnboarding
get
Worker Termination
Retrieve a worker termination.
get
Create a worker termination.
post
Delete a worker termination.
del
Update a worker termination.
put
Worker Work Location
Retrieve work locations
get
Retrieve a work location
get
Worker Payment Record
Retrieve all WorkerPaymentRecords
get
Organization Compensation Policy
Retrieve all OrganizationCompensationPolicies
get
Retrieve OrganizationCompensationPolicies
get
Deduction
Retrieve all PartnerDeductionTypes
get
Retrieve a single PartnerDeductionType
get
Paystream
Send Paystream item
post
Import Employers
post
Import payroll elements
post
Import employer risk metrics on partner platform
post
Import Workers
post
SSO Connection
Retrieve all SSO Connections
get
Retrieve SSO Connection by Id
get
Update SSO Connection
put
Usage
Retrieve all employers' usage metrics
get
Retrieve employer usage metrics
get
Webhook Endpoint
Retrieve all WebhookEndpoints
get
Create WebhookEndpoint
post
Retrieve WebhookEndpoint
get
Update WebhookEndpoint
put
Webhook Events
Lifecycle Webhook Events
AccountingConfiguration.created
post
AccountingConfiguration.updated
post
Document.uploaded
post
Employer.AccountStanding.requirementsChanged
post
Employer.AccountStanding.statusChanged
post
Employer.Address.created
post
Employer.Address.deleted
post
Employer.Address.updated
post
Employer.PayWorkersReadiness.requirementsChanged
post
Employer.PayWorkersReadiness.statusChanged
post
Employer.PayrollHistory.importCompleted
post
Employer.PayrollHistory.provided
post
Employer.PayrollHistory.required
post
Employer.TaxesSetup.updated
post
Employer.WorkerPayGroup.created
post
Employer.WorkerPayGroup.deleted
post
Employer.WorkerPayGroup.updated
post
Employer.awaitingRiskInsights
post
Employer.created
post
Employer.deleted
post
Employer.onboardingStatus
post
Employer.updated
post
EmployerBankAccount.Verification.statusChanged
post
EmployerBankAccount.created
post
EmployerBankAccount.deleted
post
EmployerBankAccount.updated
post
EmployerSignatory.created
post
EmployerSignatory.deleted
post
EmployerSignatory.updated
post
PayrollRun.EmployerFunding.statusChanged
post
PayrollRun.WorkerDisbursement.MoneyMovementTransaction.statusChanged
post
PayrollRun.awaitingInput
post
PayrollRun.deleted
post
PayrollRun.statusChanged
post
Transmission.completed
post
Transmission.failed
post
Transmission.processing
post
Worker.PaymentsReadiness.statusChanged
post
Worker.Termination.statusChanged
post
Worker.created
post
Worker.deleted
post
Worker.onboardingStatus
post
Worker.updated
post
WorkerBankAccount.created
post
WorkerBankAccount.deleted
post
WorkerBankAccount.updated
post
WorkerContract.created
post
WorkerContract.deleted
post
WorkerContract.updated
post
WorkerPayDistribution.updated
post
WorkerPaymentAdjustment.created
post
WorkerPersonalInformation.created
post
WorkerPersonalInformation.updated
post
Notification Webhook Events
Notification.Employer.taxRateUpdatedFromAgency
post
Notification.EmployerBankAccount.microDepositVerificationCompleted
post
Notification.EmployerBankAccount.microDepositVerificationFailed
post
Notification.EmployerBankAccount.microDepositVerificationSent
post
Notification.EmployerBankAccount.paymentAuthorizationCompleted
post
Notification.Payment.employerFundingFailed
post
Notification.Payment.employerFundingRedebitCleared
post
Notification.Payment.employerFundingRescheduled
post
Notification.Payment.workerDisbursementFailed
post
Notification.Payment.workerDisbursementRefundScheduled
post
Notification.Payment.workerDisbursementScheduled
post
Notification.employerPaydayReminder
post
Notification.employerPayrollHistoryRequired
post
Notification.employerPayrollOperation
post
Notification.employerPayrollRunConfirmation
post
Notification.employerRegulatoryScreeningRequestForInformation
post
Notification.workerPayday
post
UI Experiences (Employer)
Employer dashboard
Run payroll
Employer onboarding
Employer setup personalization
Employer taxes setup
Employer sign documents
Employer pay groups
Employer onboard workers
Employer address list
Employer bank accounts
Employer profile
Worker profile
Onboard worker
Payroll runs list
Employer documents
UI Experiences (Worker)
Worker self onboarding
Worker self managed profile
Worker payments list
Worker documents
Salsa.js
Salsa.js Web SDK
Powered by
Worker.created
Ask AI
wbhk
Worker.created
Triggers
Worker.created
when a Worker is created.
