For AI agents: visit https://docs.salsa.dev/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
Jump to Content
salsa
DocumentationReference
Log Insalsa
Reference
Log In
DocumentationReference

Overview

  • Reference Overview

REST API

  • Authentication
    • Create User API tokenpost
  • Documents
    • Retrieve Documentget
    • Generate document linkpost
  • Employers
    • Retrieve Employersget
    • Create Employerpost
    • Delete Employerdel
    • Retrieve Employerget
    • Update Employerput
    • Retrieve EmployerContactMethodsget
    • Retrieve an EmployerContactMethodget
    • Retrieve all worker terminations of an employer.get
    • Accept or reject Employer Terms of Servicepost
  • Employer Account Standing
    • Retrieve employer account standing.get
  • Employer Capabilities
    • Retrieve employer capabilities.get
  • Benefit
    • Retrieve all EmployerBenefitTypesget
    • Create EmployerBenefitTypepost
    • Delete EmployerBenefitTypedel
    • Retrieve a single EmployerBenefitTypeget
    • Update EmployerBenefitTypepatch
    • Retrieve all PartnerBenefitTypesget
    • Retrieve a single PartnerBenefitTypeget
  • Deduction
    • Retrieve all PartnerDeductionTypesget
    • Retrieve a single PartnerDeductionTypeget
    • Retrieve all EmployerDeductionTypesget
    • Create EmployerDeductionTypepost
    • Delete EmployerDeductionTypedel
    • Retrieve a single EmployerDeductionTypeget
    • Update EmployerDeductionTypepatch
  • Pay
    • Retrieve all EmployerPayTypesget
    • Create EmployerPayTypepost
    • Delete EmployerPayTypedel
    • Retrieve a single EmployerPayTypeget
    • Update EmployerPayTypepatch
    • Retrieve all PartnerPayTypesget
    • Retrieve a single PartnerPayTypeget
  • Time Off
    • Retrieve all EmployerTimeOffTypesget
    • Create EmployerTimeOffTypepost
    • Delete EmployerTimeOffTypedel
    • Retrieve a single EmployerTimeOffTypeget
    • Update EmployerTimeOffTypepatch
    • Retrieve all PartnerTimeOffTypesget
    • Retrieves a single PartnerTimeOffTypeget
  • Mock Onboarding
    • Mock-onboard Employerpost
    • Mock-onboard Workerpost
  • Employer Onboarding
    • Retrieve list of HostedEmployerOnboardingget
    • Create HostedEmployerOnboardingpost
    • Retrieve HostedEmployerOnboardingget
  • Payroll Runs
    • Retrieve all PayrollRunsget
    • Create PayrollRunpost
    • Preview PayrollRunpost
    • Delete PayrollRundel
    • Retrieve PayrollRunget
    • Confirm PayrollRunpost
    • Retrieve PayrollRun stateget
    • Retrieve all WorkerPaymentRecordsget
    • Modify a WorkerPaymentpatch
  • Payroll Run Reports
    • Cash Requirements reportget
    • Payroll Journal report (Deprecated)get
    • Overtime reportget
  • Period Preview
    • Preview a periodpost
  • Employer Reports
    • Payroll Journal reportpost
  • Employer Signatories
    • Retrieve all Employer Signatoriesget
    • Create a new Employer Signatorypost
    • Retrieve an Employer Signatoryget
    • Update an Employer Signatoryput
  • Employer Work Location
    • Retrieve work locations.get
    • Retrieve a work location.get
  • Work Weeks
    • Retrieve all EmployerWorkWeeksget
    • Create EmployerWorkWeekpost
    • Delete EmployerWorkWeekdel
    • Retrieve EmployerWorkWeekget
    • Update EmployerWorkWeekpatch
  • Worker Pay Groups
    • Retrieve all WorkerPayGroupsget
    • Create WorkerPayGrouppost
    • Delete WorkerPayGroupdel
    • Retrieve WorkerPayGroupget
    • Update WorkerPayGroupput
  • Worker Payments
    • Delete WorkerPaymentdel
    • Retrieve WorkerPaymentget
    • Advance Paymentpost
    • Get compensationsget
    • Creates compensationput
    • Confirm WorkerPaymentpost
    • Get deductionsget
    • Creates deductionput
    • Get payget
    • Creates or updates pay for a particular worker paymentput
    • Get WorkerPaymentRecordget
    • Retrieve WorkerPaymentsget
    • Create WorkerPaymentpost
  • Workers
    • Retrieve Workersget
    • Create Workerpost
    • Delete Workerdel
    • Retrieve Workerget
    • Update Workerput
  • Worker Capabilities
    • Retrieve worker capabilities.get
  • Worker Contract
    • Retrieve WorkerContractsget
    • Create WorkerContractpost
    • Update WorkerContractpatch
  • Worker Onboarding
    • Retrieve list of HostedWorkerOnboardingget
    • Create HostedWorkerOnboardingpost
    • Retrieve HostedWorkerOnboardingget
  • 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 WorkerPaymentRecordsget
  • Paystream
    • Send Paystream itempost
    • Import Employerspost
    • Import payroll elementspost
    • Import employer risk metrics on partner platformpost
    • Import Workerspost
  • SSO Connection
    • Retrieve all SSO Connectionsget
    • Retrieve SSO Connection by Idget
    • Update SSO Connectionput
  • Usage
    • Retrieve all employers' usage metricsget
    • Retrieve employer usage metricsget
  • Webhook Endpoint
    • Retrieve all WebhookEndpointsget
    • Create WebhookEndpointpost
    • Retrieve WebhookEndpointget
    • Update WebhookEndpointput
  • Webhook Events
  • Lifecycle Webhook Events
    • AccountingConfiguration.createdpost
    • AccountingConfiguration.updatedpost
    • Document.uploadedpost
    • Employer.AccountStanding.requirementsChangedpost
    • Employer.AccountStanding.statusChangedpost
    • Employer.Address.createdpost
    • Employer.Address.deletedpost
    • Employer.Address.updatedpost
    • Employer.PayWorkersReadiness.requirementsChangedpost
    • Employer.PayWorkersReadiness.statusChangedpost
    • Employer.PayrollHistory.importCompletedpost
    • Employer.PayrollHistory.providedpost
    • Employer.PayrollHistory.requiredpost
    • Employer.PayrollHistory.statusChangedpost
    • Employer.PayType.createdpost
    • Employer.PayType.deletedpost
    • Employer.PayType.updatedpost
    • Employer.TaxesSetup.updatedpost
    • Employer.TimeOffType.createdpost
    • Employer.TimeOffType.deletedpost
    • Employer.TimeOffType.updatedpost
    • Employer.WorkerPayGroup.createdpost
    • Employer.WorkerPayGroup.deletedpost
    • Employer.WorkerPayGroup.updatedpost
    • Employer.awaitingRiskInsightspost
    • Employer.createdpost
    • Employer.deletedpost
    • Employer.onboardingStatuspost
    • Employer.updatedpost
    • EmployerBankAccount.Verification.statusChangedpost
    • EmployerBankAccount.createdpost
    • EmployerBankAccount.deletedpost
    • EmployerBankAccount.updatedpost
    • EmployerSignatory.createdpost
    • EmployerSignatory.deletedpost
    • EmployerSignatory.updatedpost
    • PayrollRun.EmployerFunding.statusChangedpost
    • PayrollRun.WorkerDisbursement.MoneyMovementTransaction.statusChangedpost
    • PayrollRun.awaitingInputpost
    • PayrollRun.deletedpost
    • PayrollRun.statusChangedpost
    • Transmission.completedpost
    • Transmission.failedpost
    • Transmission.processingpost
    • Worker.PaymentsReadiness.statusChangedpost
    • Worker.Termination.statusChangedpost
    • Worker.createdpost
    • Worker.deletedpost
    • Worker.onboardingStatuspost
    • Worker.updatedpost
    • WorkerBankAccount.createdpost
    • WorkerBankAccount.deletedpost
    • WorkerBankAccount.updatedpost
    • WorkerContract.createdpost
    • WorkerContract.deletedpost
    • WorkerContract.updatedpost
    • WorkerPayDistribution.updatedpost
    • WorkerPaymentAdjustment.createdpost
    • WorkerPersonalInformation.createdpost
    • WorkerPersonalInformation.updatedpost
    • Worker.TaxesSetup.updatedpost
  • Notification Webhook Events
    • Notification.Employer.taxRateUpdatedFromAgencypost
    • Notification.EmployerBankAccount.microDepositVerificationCompletedpost
    • Notification.EmployerBankAccount.microDepositVerificationFailedpost
    • Notification.EmployerBankAccount.microDepositVerificationSentpost
    • Notification.EmployerBankAccount.paymentAuthorizationCompletedpost
    • Notification.Payment.employerFundingFailedpost
    • Notification.Payment.employerFundingRedebitClearedpost
    • Notification.Payment.employerFundingRescheduledpost
    • Notification.Payment.workerDisbursementFailedpost
    • Notification.Payment.workerDisbursementRefundScheduledpost
    • Notification.Payment.workerDisbursementScheduledpost
    • Notification.employerPaydayReminderpost
    • Notification.employerPayrollHistoryRequiredpost
    • Notification.employerPayrollOperationpost
    • Notification.employerPayrollRunConfirmationpost
    • Notification.workerPaydaypost

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
  • Employer reports

UI Experiences (Worker)

  • Worker self onboarding
  • Worker self managed profile
  • Worker payments list
  • Worker documents

Salsa.js

  • Salsa.js Web SDK
Powered by 

Webhook Events

Webhooks are used by Salsa to notify you of changes in your account and are categorized into two types: Lifecycle and Notification.

  • Lifecycle Webhook Events
  • Notification Webhook Events

Updated 5 months ago


Update WebhookEndpoint
Lifecycle Webhook Events
Did this page help you?

Updated 5 months ago


Update WebhookEndpoint
Lifecycle Webhook Events
Did this page help you?