Changelog

This page contains a log of notable changes to the API and webhooks, to help you understand what has changed and how it might affect your integrations.

For a full changelog including all changes, please see the Apollo Studio changelog.

2025-06-03

Low Impact Changes

Webhook hire status field

A new hireStatus field has been added to all hire-related webhook payloads within the contract object. This field provides a consistent way to track hire status across all webhook events.

The field is included in the following webhook events:

  • contractAccepted
  • hireCancelled
  • hireEnded
  • hireTerminated
  • hireUpdated

Possible values include: draft, offered, signed, active, ended, cancelled, and terminated.

Example payload structure:

{
    "event": "hireUpdated",
    "data": {
        "contract": {
            "id": "Q29udHJhY3Q6MTIzNA==",
            "hireStatus": "active",
            ...
        },
        "worker": { ... }
    }
}

This is a non-breaking change - existing webhook consumers will continue to work without modification, and the existing contract.status field remains unchanged.

2024-09-02

View the full changelog for this date on Apollo Studio.

Low Impact Changes

Job payment schemes

The Job.paymentScheme field and related arguments have been deprecated as part of our platform simplification efforts and will be removed from the API on the 29th September 2024.

No direct replacement is planned.

2024-08-29

View the full changelog for this date on Apollo Studio.

Low Impact Changes

Payment request type

All references to bills have been removed from the API.

2024-02-27

View the full changelog for this date on Apollo Studio.

Medium Impact Changes

Hire date properties

The dateStart and dateEnd fields have been deprecated.

Please migrate to the new startDate and endDate fields as soon as possible.

2024-02-12

View the full changelog for this date on Apollo Studio.

Medium Impact Changes

Payment request type

The Bill type has been renamed to PaymentRequest, and corresponding references to bills are now deprecated and will be removed from the API on the 29th August 2024.

Please migrate any uses of the following in your integrations:

  • bill should be renamed to paymentRequest
  • bills should be renamed to paymentRequests