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

Documentation Reference

Reference

Documentation Reference

Overview

Reference Overview

REST API

Authentication
- Create User API tokenpost
Documents
- Retrieve Documentget
- Generate document linkpost
Employers
Employer Account Standing
- Retrieve employer account standing.get
Employer Capabilities
- Retrieve employer capabilities.get
Benefit
Deduction
Pay
Time Off
Mock Onboarding
- Mock-onboard Employerpost
- Mock-onboard Workerpost
Employer Onboarding
Payroll Runs
Payroll Run Reports
Period Preview
- Preview a periodpost
Employer Reports
- Payroll Journal reportpost
Employer Signatories
Employer Work Location
- Retrieve work locations.get
- Retrieve a work location.get
Work Weeks
Worker Pay Groups
Worker Payments
Workers
Worker Capabilities
- Retrieve worker capabilities.get
Worker Contract
Worker Onboarding
Worker Termination
Worker Work Location
- Retrieve work locations.get
- Retrieve a work location.get
Worker Payment Record
- Retrieve all WorkerPaymentRecordsget
Paystream
SSO Connection
Usage
- Retrieve all employers' usage metricsget
- Retrieve employer usage metricsget
Webhook Endpoint
Webhook Events
Lifecycle Webhook Events
Notification Webhook Events

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

PayrollRun.statusChanged

wbhk

PayrollRun.statusChanged

Triggers PayrollRun.statusChanged when a payroll run status has changed.

Payload

Webhook payload

data

object

required

Response

200

Webhook received successfully

Updated 3 months ago

PayrollRun.deleted

Transmission.completed

Did this page help you?

Loading…

Updated 3 months ago

PayrollRun.deleted

Transmission.completed

Did this page help you?