These docs are for v2024-03-01. Click to read the latest docs for v2025-06-15.
added

Added webhooks for updates to payment method types

We've added employee.payment_method_type_updated and contractor.payment_method_type_updated webhooks. These are emitted when the payment method for an employee or contractor changes: for example, if a payment method changes from "Check" to "Direct Deposit".

added

Added webhooks for effective employee terminations and rehires

Added employee.terminated_effective and employee.rehire_effective webhooks, which are emitted when the respective termination or rehire is effective.

added

Added Employee Management flow

We're excited to announce the launch of our new Employee Management flow, a centralized interface for managing W-2 employees throughout their lifecycle.

added

Added completed_at field to company onboarding status endpoint

Added completion timestamps to the GET /v1/company/onboarding_status endpoint to help you track when your companies complete each onboarding step. This enables you to integrate with marketing automation platforms (e.g., Mailchimp, Iterable) and send targeted onboarding nudges when companies get stuck.

added

Added webhook healthcheck endpoint

Added the GET /v1/webhooks/health_check endpoint to monitor the status of our webhook system. Poll this endpoint to check webhook delivery health within the last 10 minutes.

added

Added categories to Partner Notification system

Added three new categories to the Embedded Partner Notification system:state_tax_setup_request_required_authorization, state_tax_setup_request_authorization, and state_tax_setup_multi_step_request_authorization.

added

Added rate limit headers

Added additional rate limit data to API response headers. The following headers are now available to use when handling rate limiting programmatically:

added

Added webhooks

Added company.unsuspended, contractor.reactivated, and ContractorPaymentGroup webhooks: contractor_payment_group.created and contractor_payment_group.cancelled.

improved

v2025-06-15

To further improve performance of our payroll API endpoints, v2025-06-15 introduces the changes outlined below.