OwnTracks Payload Builder

_type=location

Reports the current GPS position of the device, including optional metadata like battery, speed, and trigger source.

Required Fields

lat * float · degrees

lon * float · degrees

tst * Unix epoch

Optional — Device

tid tracker ID, 2 chars

batt % 0–100

bs battery status

conn connectivity

Optional — GPS

acc accuracy · meters

alt altitude · meters

vel velocity · km/h

cog course · degrees

vac vertical accuracy · m

p pressure · kPa

Optional — Trigger & Context

t trigger

poi point of interest

tag iOS tag name

topic HTTP mode only

SSID WiFi name · iOS

BSSID Access point · iOS

m monitoring mode

inregions comma-separated

_type=waypoint

Define a geofence region or BLE beacon that the app will monitor for enter/leave events.

Required Fields

desc * waypoint name

tst * creation epoch

Geographical Region (optional)

lat float · degrees

lon float · degrees

rad radius · meters

BLE Beacon (optional)

uuid BLE beacon UUID · iOS

major integer · iOS

minor integer · iOS

_type=transition

Sent when the device enters or leaves a previously configured region or BLE beacon.

Required Fields

tst * event epoch

wtst * waypoint creation epoch

acc * accuracy · meters

event *

Optional Fields

lat event latitude

lon event longitude

tid tracker ID

desc region name

t trigger

rid region ID

_type=lwt

Last Will and Testament — sent by the broker when the device disconnects ungracefully.

Fields

tst * disconnect epoch

_type=card

Publishes the user's display name and avatar image (Base64 JPEG). Retained on the broker.

Fields

tid * tracker ID, 2 chars

name display name

face Base64-encoded JPEG

_type=cmd

Remote command sent to the device via its /cmd topic. Use setConfiguration to push full config objects.

Action

action *

Connection

host

port

clientId

deviceId

tid tracker ID

username

password

keepalive seconds

mqttProtocolLevel

connectionTimeoutSeconds

Topics & QoS

pubTopicBase

subTopic

pubQos

subQos

pubRetain

cleanSession

Tracking

monitoring mode

locatorInterval seconds

locatorDisplacement meters

locatorPriority Android

ignoreInaccurateLocations meters

ignoreStaleLocations hours

ping interval · minutes

App Behaviour

cmd (accept remote cmds)

sub (subscribe)

auth

tls

ws (WebSocket)

allowinvalidcerts

allowRemoteLocation

ranging (BLE · iOS)

extendedData

autostartOnBoot · Android

remoteConfiguration

notificationLocation

locked

debugLog

pegLocatorFastestInterval

maxHistory

positions

days

mode 0=MQTT,3=HTTP

url HTTP mode endpoint

httpHeaders JSON object · HTTP mode

Security / Encryption

encryptionKey

clientpkcs iOS · pkcs12 filename

passphrase iOS · pkcs12 passphrase

tlsClientCrtPassword Android

Map / Geocoding (iOS)

osmTemplate tile URL template

osmCopyright

opencageApiKey Android geocoding

_type=steps

Step counter report — iOS only. Returns -1 if step counting is not available.

Fields

tst * request epoch

steps count (−1 = unavailable)

from period start epoch

to period end epoch

_type=encrypted

Wrapper for an encrypted, Base64-encoded JSON payload. The encryption key is never exported with configurations.

Required Fields

data * Base64-encoded encrypted payload

← select a device to publish