Sign in

v62

latestOpenAPI 3.0.3raw.githubusercontent.com2026-07-31136116265.6 KB
external devices

Creates an event using specified webhook

post/v1/products/{productUID}/ext-devices/{deviceUID}/event

Path parameters

productUIDstring required
deviceUIDstring required

Request body

appstring

App UID (globally unique)

barsinteger

Bars. Only available on _session.qo events.

best_countrystring

Country

best_idstring

The device serial number, or the DeviceUID if the serial number is not set

best_latnumber double

Latitude

best_locationstring

Location

best_location_typestring

One of "gps", "triangulated", or "tower"

best_location_wheninteger

Unix timestamp

best_lonnumber double

Longitude

best_timezonestring

Timezone

bodyobject

A JSON object containing event details

bssidstring

BSSID. Only available on _session.qo events.

devicestring

Device UID (globally unique)

environmentobject

Routed environment variables beginning with "$". Only available on _session.qo events.

eventstring

Event UID (globally unique)

filestring

The notefile associated with this event

movedinteger

The number of times the device was sensed to have moved between the last session and this session. Only available on _session.qo events.

notestring

The note ID in the notefile

ordering_codestring

Ordering code. Only available on _session.qo events.

orientationstring

The orientation of the device. Only available on _session.qo events.

payloadstring

A base64-encoded binary payload

productstring

Product UID (globally unique)

ratstring

Rat. Only available on _session.qo events.

receivednumber double

The unix timestamp when the event was received

reqstring

The notecard request

rsrpinteger

RSRP. Only available on _session.qo events.

rsrqinteger

RSRQ. Only available on _session.qo events.

rssiinteger

Received Signal Strength Indicator (RSSI) is an estimated measurement of how well a device can receive signals. Only available on _session.qo events.

sensorstring

Sensor UID, for events originating from a sensor attached to the device

sessionstring

Session UID (globally unique)

sinrinteger

SINR. Only available on _session.qo events.

skustring

SKU. Only available on _session.qo events.

snstring

The device serial number

ssidstring

SSID. Only available on _session.qo events.

tempnumber double

Device temperature. Only available on _session.qo events.

tlsboolean

Whether TLS was used on the connection between the device and notehub. Only available on _session.qo events.

tower_countrystring

Country

tower_idstring

Tower ID

tower_latnumber double

Latitude

tower_locationstring

Location

tower_lonnumber double

Longitude

tower_timezonestring

Timezone

tower_wheninteger

Unix timestamp

transportstring

The transport used for this event, e.g., "cellular", "wifi", ", etc.

tri_countrystring

Country

tri_latnumber double

Latitude

tri_locationstring

Location

tri_lonnumber double

Longitude

tri_pointsinteger

Triangulation points

tri_timezonestring

Timezone

tri_wheninteger

Unix timestamp

updatesinteger
voltagenumber double

Device voltage. Only available on _session.qo events.

wheninteger

When the event was captured on the device

when_msinteger

Millisecond-accurate Unix epoch timestamp for when the event was captured on the device

where_countrystring

Country

where_latnumber double

Latitude

where_locationstring

Location

where_lonnumber double

Longitude

where_olcstring

Open Location Code

where_timezonestring

Timezone

where_wheninteger

Unix timestamp

Example request

{
  "bars": 2,
  "best_location_when": 1652709545,
  "moved": 7,
  "rsrp": -91,
  "rsrq": -13,
  "rssi": -72,
  "sinr": 18,
  "tower_when": 1669667691,
  "tri_points": 6,
  "tri_when": 1652709545,
  "updates": 1,
  "when": 1656010061,
  "when_ms": 1656010061123,
  "where_when": 1652709545
}

Response

Event Created Successfully