Contact
English

API changelog

Changes to the ChaosDesk REST API, the Zendesk-compatible API and the official client libraries, newest first.

We add to the API without breaking it: new endpoints, new optional parameters and new response fields can appear at any time, so ignore fields you do not know. Nothing is removed or retyped in place. Anything that would break an integration is announced here at least 12 months ahead, with Deprecation and Sunset headers on the affected operations and an e-mail to workspace owners, and the old shape keeps working for that whole period. The full rules are on API versioning and deprecation.

Entries are grouped as Added, Changed, Deprecated and Removed. Nothing has been deprecated or removed yet.

2026-11-06

Added

  • Official client libraries for PHP (chaosdesk/chaosdesk-php), Node.js (@chaosdesk/api) and Python (chaosdesk), generated from the OpenAPI document, and a Postman collection. See client libraries.
  • Profiles and events API on the Zendesk-compatible API, shaped like Zendesk’s: PUT /zd/api/v2/user_profiles?identifier=, GET /zd/api/v2/users/{user_id}/profiles, POST /zd/api/v2/user_profiles/events, GET /zd/api/v2/users/{user_id}/events and more. Profiles from several systems resolve to one customer by email, phone or external id.
  • App marketplace: developers submit apps built on the app framework for review; admins install reviewed apps with one click.
  • Configuration as code: GET and POST /zd/api/v2/chaosdesk/config.yaml pull and push an account’s fields, forms, rules, SLAs and views as YAML, with a dry run.
  • Zendesk-compatible API: users update, show_many and delete; organizations create, update, delete and search; satisfaction ratings; macros with apply; views with execute and counts; search export.

1.0.0

  • First public version of the REST API (/api), documented in the API reference, and the Zendesk-compatible API (/zd/api/v2).