API brownout
For old API versions that are soon to be retired, we run a 24 hour brownout which is a deliberate disruption of
your API integration. All requests will return the error 410 Gone during this 24-hour window.
The purpose of a brownout is to make sure you are aware that the current API version is about to be removed.
This time window should be enough to make existing integrations fail and thus notify IT-teams, but short enough
that it shouldn't disrupt your workflows. For example, an employee that couldn't be synced during the brownout will
succeed when the API integration retries the next day.
How to avoid brownouts
By upgrading your API version well in advance you will not experience any brownouts. We send out an email when a
new version is released and will also send you reminders when your API version is nearing retirement. The last
reminder, which is delivered 3 months before the version is retired, details the exact date the brownout will happen.
The date of a brownout is always a weekday about 2 months before the version retirement.
See our API versioning documentation for more information about upgrading.
If you are experiencing a brownout right now
The brownout runs for 24 hours from 00:00 to 23:59 UTC and will fail all requests with a 410 Gone HTTP response code.
Retry the requests once the brownout ends. Treat this brownout as a notice that your integration is running on a version
that is about to be unsupported and should be promptly upgraded.
Updated 1 day ago
