Skip to content

V1 Event API Changes (Sept 2022)

Jim Salem edited this page Sep 14, 2022 · 5 revisions

To ensure consistency between Notehub routed events and our API, we are updating the data structures returned by the V1 Events APIs to exactly match the event data structure used for routed events. This update is targeted for the week of September 19th. The specific time of the update will be posted to https://status.notehub.io/ at least 24 hours in advance.

If you use one of the following APIs, you will need to update your code to use the new field names as shown below.

https://api.notefile.net/v1/projects/{uid}/events

Current Field Name Updated Field Name Notes
body body (unchanged)
captured when unix timestamp
device_uid device
file file (unchanged)
gps_location.country where_country
gps_location.latitude where_lat
gps_location.longitude where_lon
gps_location.name where_location
gps_location.timezone where_timezone
gps_location.when where_when
received received unix timestamp
tower_location.country tower_country
tower_location.latitude tower_lat
tower_location.longitude tower_lon
tower_location.name tower_location
tower_location.timezone tower_timezone
tower_location.when tower_when
uid event

https://api.notefile.net/v1/projects/{uid}/devices/{uid}/latest

Current Field Name Updated Field Name Note
body body (unchanged)
captured when unix timestamp
event_uid event
file file (unchanged)
received received unix timestamp

The full definition of the event structure can be found here: https://github.com/blues/note-go/blob/main/note/event.go