added
Oyster API updates - 26 May 2025
about 1 month ago
v0.1 Employments API updates, v0.1 Engagements API updates, v0.1 Invoicing API updates, v0.1 Payments API release, v1 Employments API updates, Benefits webhooks release, Contract Changes webhooks release, Offboarding webhooks release, Invoicing webhooks updates
v0.1 API
v0.1 Employments API updates
- Release includes: Invite team member
v0.1 Engagements API updates
- Release includes: Create a document requests for an engagement, Retrieve a document request for an engagement, Retrieve document requests for an engagement
v0.1 Invoicing API updates
- Release includes the following new objects in the Retrieve an invoice and Retrieve all invoices responses:
charge,payout
v0.1 Payments API release
- Release includes: Retrieve a charge, Retrieve a payout
v1 API
v1 Employments API updates
- Release includes: Fetch the onboarding form, Upload a document to the onboarding form, Update the onboarding form, Retrieve an individual employment, Delete employment, Mark onboarding form as complete,
Webhooks
Contract Changes webhooks release
- Release includes: contract.change_requested, contract.change_updated
Offboarding webhooks release
- Release includes: offboarding.agreement_generated, offboarding.agreement_sent_for_signature, offboarding.agreement_signed, offboarding.approved, offboarding.cancellation_requested, offboarding.cancelled, offboarding.engagement_terminated, offboarding.initiated, offboarding.request_updated
Payments webhooks release
- Release includes: payments.charge_direct_debit_initiated, payments.charge_failed, payments.charge_marked_as_overdue, payments.charge_paid, payments.charge_unpaid, payments.charge_wire_transfer_requested