Where changes are announced
Three changelogs, on purpose
| Where | Carries | Who it is for |
|---|---|---|
| Developer changelog | endpoints, fields, scopes, webhook events, SDK releases | you |
| lockally.com/changelog | product changes in plain language | the people who use the console and webmail |
| Internal engineering log | migrations, infrastructure, suppliers | not published |
They are separate because the audiences are. A migration number is noise on the product changelog, and “we made the mailbox page clearer” is noise here.
Watch the developer changelog for anything that can change your code.
What counts as a change worth announcing
| Announced | Notice | |
|---|---|---|
| A new endpoint, field or event type | yes | none, it is additive |
| A new SDK release | yes | none |
| A field or endpoint deprecated | yes | at least 30 days |
A breaking change to /v1 |
yes | at least 30 days |
| A bug fix that changes a wrong response to a right one | yes | none |
| Infrastructure work with no API effect | no | see status |
Additive changes arrive without warning, which is why a tolerant client matters: unknown JSON fields should be ignored rather than rejected, and an unrecognised error code should degrade to its status class. See Versioning and deprecation.
Nothing is deprecated today
The mechanism exists and is unused. When something is deprecated its responses will carry:
Deprecation: true
Sunset: Sun, 31 Jan 2027 00:00:00 GMT
Link: <https://developers.lockally.com/changelog/>; rel="deprecation"
The one deprecated thing on the platform right now is a field, not an
endpoint: lockally_id on delivery events, which repeats message_id. A
response header about an endpoint cannot signal a field, so that one lives in
the changelog only.
Incidents are not changelog entries
status.lockally.com carries live and historical incidents, and uptime measured from them rather than asserted.
An outage is not a change, and putting the two in one feed means people stop reading the one they need. If you want to be told when sending is degraded, watch status rather than the changelog.
Following along
- The developer changelog is a page on this site, so an RSS-style watcher or a scheduled diff of it works
- Breaking changes and deprecations also arrive in response headers, so a
client that logs an unexpected
Deprecationheader finds out without anybody reading anything GET /v1/eventswill not tell you about platform changes; it is your own event log