Compatibility Policy
Backward-compatible changes
Since July 1st 2021 the changes listed below are considered backward-compatible. Such changes will not be advertised or communicated before deployment. Consumers are expected to automatically handle and accept those changes gracefully and silently.
- New CSV files can be added to the ZIP export file to cover new uses-cases
- Existing columns can be deprecated. When this happens, their content will be replaced by a constant value that depends on the type of the field
Backward-incompatible changes
Since July 1st 2021, we are committed to advertise at least two months in advance to existing consumers backward-incompatible changes and to provide version control flags per consumer for at least two month before forcing the migration of existing exports to a new incompatible format.
The changes listed below are considered backward-incompatible:
- One or more CSV files are removed from the ZIP export file
New columns are added to existing CSV data files- Existing columns are removed from existing CSV data files
Update: Since December 27th 2023, adding new columns at the end of an existing CSV data files is not considered anymore as a backward-incompatible change.
Changelog
Date | Description |
---|---|
December 2023 | Add new colums external_id and alt_external_id to site.csv |
November 2022 | Introduce new column is_bot in users.csv |
September 2022 | Introduce optins.csv, and optin-events.csv |
March 2022 | Introduce annotations.csv, help-requests.csv, help-request-answers.csv |
September 2021 | Introduce first-human-answer-delay-per-conversation.csv |
June 2021 | Add conversation_id column in tasks.csv |
February 2021 | Introduce nps.csv |
April 2020 | Introduce first-human-answer-delays.csv |
July 2019 | Introduce logins.csv |
Updated 12 months ago