Oyster API updates - 11 June 2025

v0.1 Employments API updates, v0.1 Benefits API updates, v0.1 Offboarding API updates, v0.1 Contract Changes updates, v1 Contract Changes updates, Engagements webhooks updates, Benefits webhooks release

v0.1 API

v0.1 Employments API updates

• Release includes: Get hiring process tasks for an employment

v0.1 Benefits API updates

• Release includes: Retrieve an enrollment

v0.1 Offboarding API updates

• Release includes new optional field in the Create a draft termination for a payroll team member endpoint: payrollPayoutMonthChange.

v0.1 Contract Changes API updates

• Release includes bug fix to Retrieve an individual contract change request and Retrieve all contract changes endpoints: fixed a bug that caused changesRequested field to generate as string instead of an array. Results now return an array.

v1 API

v1 Contract Changes API updates

• Release includes bug fix to Retrieve an individual contract change request and Retrieve all contract changes endpoints: fixed a bug that caused changesRequested field to generate as string instead of an array. Results now return an array.

Webhooks

Engagements webhooks updates

• Release includes: engagements.document_request_ready

Benefits webhooks release

• Release includes: benefits.provisioning_updated, benefits.enrollment_applied, benefits.enrollment_canceled, benefits.enrollment_created, benefits.enrollment_enrolled, benefits.enrollment_finished, benefits.enrollment_opted_out, benefits.enrollment_processing_initiated, benefits.enrollment_requested