Oyster API updates - 25 April 2025

v0.1 Contract Changes API updates, v0.1 Payroll Changes API updates, v0.1 Benefits API updates, v0.1 Webhooks API updates, v1 Expenses API updates, v1 Payroll Changes API updates

v1 Benefits API release

Engagements webhooks release, Invoicing webhooks release

v0.1 API

Release of new v0.1 Benefits API endpoints

• Release includes: Retrieve benefits ruleset

Release of new v0.1 Contract Changes API endpoints

• Release includes: Retrieve rulesets for creating a contract change

Release of new v0.1 Payroll Changes API endpoints

• Release includes: Retrieve payroll changes rulesets for source types, Retrieve default payroll changes rulesets for source types

Release of new v0.1 Webhooks API endpoints

• Release includes: Retrieve all webhook dispatches

v1 API

Release of v1 Benefits API

• Release includes: Retrieve an employment's available benefits offerings, Retrieve an employment's provisioned benefits, Provision benefits, Retrieve benefits ruleset

Release of new v1 Employments API endpoints

• Release includes: Rulesets for updating employment of particular country and subdivision

Additional parameter in the v1 Expenses POST Create expense endpoint

• Release includes the following new optional parameter: pendingApproval. If this parameter is absent, the expense will be created in the approved status.

Release of new v1 Payroll Changes API endpoints

• Release includes: Retrieve payroll changes rulesets for source types, Retrieve default payroll changes rulesets for source types

Webhooks

Release of Engagements webhooks

• Release includes: engagements.document_uploaded, engagements.payslip_uploaded

Release of Invoicing webhooks

• Release includes: invoicing.invoice_issued, invoicing.invoice_approved, invoicing.invoice_voided