GPS Message
Event Type: GPS_MESSAGE
Trigger Condition
Subscription to the GPS_MESSAGE event is mandatory. The tracking frequency must be configured at the customer level. If not explicitly set, the system defaults to a 2-minute tracking frequency. The event is published to the configured webhook whenever the device sends GPS data according to the set tracking interval.
Example Payload
{
"id": "24005889-ff01-4e98-aee5-c9f25269db3e",
"type": "GPS_MESSAGE",
"spare": 0,
"speed": 50,
"course": 88,
"offset": 150,
"userId": "79f63e90-a0cf-11ef-94bc-ad932108ba0d",
"assetNo": "",
"groupId": "060b952b-28c5-11e7-8384-911724969dc5",
"jmsType": "",
"roaming": 0,
"stateId": 0,
"altitude": 12,
"deviceId": "798924df-a0cf-11ef-94bc-d721153776c0",
"dilution": 8,
"latitude": 49.4064494,
"location": {
"latitude": 49.4064494,
"longitude": 92.3528425
},
"needHelp": false,
"obdSpeed": 3,
"odometer": 1890,
"userName": "5134555555 .",
"breakDown": false,
"eventCode": 0,
"fixStatus": 0,
"groupName": "Default Group",
"imei_meid": "513455555551345555",
"inputBit0": 0,
"inputBit1": 0,
"inputBit2": 0,
"inputBit3": 0,
"inputBit4": 0,
"inputBit5": 0,
"inputBit6": 0,
"inputBit7": 0,
"insideHOO": true,
"longitude": 92.3528425,
"network3G": 0,
"processed": true,
"tripState": "ACTIVE",
"vehicleId": "7988d6be-a0cf-11ef-94bc-0fce622cd4cc",
"customerId": 5134,
"eventIndex": 0,
"fixQuality": 0,
"invalidFix": 0,
"noOfAccums": 0,
"tripNumber": 12345,
"unitStatus": 0,
"commonState": 0,
"dataService": 0,
"deviceSpeed": 3,
"messageType": "GPS_MESSAGE",
"temperAlert": false,
"vehicleName": "5134555555",
"currentState": 0,
"deviceSerial": "5134555555",
"deviceTypeId": 1,
"dimentionFix": 0,
"lastKnownLat": 0,
"lastKnownLon": 0,
"locationTime": 1731400024000,
"messageIndex": "463148",
"partitionKey": "5134555555",
"tripDistance": 3,
"vendorTypeId": 1,
"airFilterClog": false,
"messageTypeId": 1,
"partialUpdate": false,
"clutchOverride": false,
"deviceAvgSpeed": 18,
"deviceMaxSpeed": 20,
"lowOilPressure": false,
"networkService": 0,
"satelliteCount": 13,
"storedLocation": false,
"tripIdlingTime": 50,
"unitStatusBit0": 0,
"unitStatusBit1": 0,
"unitStatusBit2": 0,
"unitStatusBit3": 0,
"virtualTripEnd": false,
"vehicleOdometer": false,
"voiceCallActive": 0,
"fixStatusPredict": 0,
"batteryPercentage": 0,
"fixStatusHistoric": 0,
"privacyModeEnable": false,
"batteryDisonnected": false,
"batteryNotCharging": false,
"commStateConnected": 0,
"fixStatusCorrected": 0,
"fixStatuslastKnown": 0,
"messageEventTypeId": 0,
"commStatusAvaliable": 0,
"lastKnownFixQuality": 0,
"protocolVersionIdChange": true
}
Reference
Field | Description |
---|---|
id String | The unique reference ID for the given event in the system Example: 24005889-ff01-4e98-aee5-c9f25269db3e |
type String | Type of Event Example: GPS_MESSAGE |
spare Integer | 0 |
speed Integer | Speed of the Vehicle Example: 50 |
course Integer | 88 |
offset Integer | device timezone offset Example: 150 |
userId Integer | The unique ID of the User Example: 79f63e90-a0cf-11ef-94bc-ad932108ba0d |
assetNo | The Asset Id associated with the device. Example : TRL201 |
groupId String | Logical Group ID the Device belongs to Example: 060b952b-28c5-11e7-8384-911724969dc5 |
jmsType String | - |
roaming Integer | Example: 0 |
stateId Integer | Refers to the vehicle ignition state or movement status, 0-Ignition Off and 1-Ignition On Example: 0 |
altitude Integer | Indicates the vehicle’s elevation above sea level in meters Example 12 |
deviceId String | The unique ID of the Device Example: 798924df-a0cf-11ef-94bc-d721153776c0 |
dilution Integer | Refers to Dilution of Precision (DOP) — a measure of the quality and accuracy of the GPS signal based on satellite geometry 1–2: Ideal — High precision, 2–5: Good — Acceptable accuracy, 5–10: Moderate — May still be usable, 10+: Poor — Low GPS accuracy Example: 8 |
location Location | Location of the Device |
latitude Double | GPS Latitude in degrees Example: 49.4064494 |
longitude Double | GPS Longitude in degrees Example: 92.3528425 |
needHelp Boolean | Indicates whether a help or emergency signal has been triggered by the user or device, such as an SOS or panic alert Example: false |
obdSpeed Integer | OBD device Speed in Kilometers per Hour Example: 3 |
odometer Integer | Odometer Reading of the Vehicle in kms Example: 1890 |
userName String | Name of the User associated to the device/vehicle Example: 5134555555 |
breakDown Boolean | Indicates whether the vehicle is experiencing a breakdown or technical issue at the time of the GPS message Example: false |
eventCode Integer | Example: 0 |
fixStatus Integer | Example: 0 |
groupName String | Name of the Group the device/vehicle is associated to Example: Default Group |
imei_meid Integer | Refers to a unique identifier of device Example: 513455555551345555 |
network3G Integer | Status of 3G Network Example: 0 |
processed Boolean | Indicates whether the data or event has been successfully processed by system Example: true |
tripState String | Represents the current status of a vehicle's trip, indicating whether the trip is active, completed, or in another state. Example: ACTIVE |
vehicleId String | The unique ID of the Vehicle Example: 7988d6be-a0cf-11ef-94bc-0fce622cd4cc |
customerId Integer | The unique Azuga ID of the Customer Example: 5134 |
tripNumber Integer | Represents a unique identifier assigned to a specific trip, allowing the system to track and reference that particular journey or route Example: 12345 |
messageType String | Type of Message Example: GPS_MESSAGE |
temperAlert Boolean | Example: false |
vehicleName String | Name of the Vehicle Example: Demo Car |
currentState Integer | Example: 0 |
deviceSerial Integer | Serial Number of the Device associated with vehicle Example: 5134555555 |
deviceTypeId Integer | ID of the Device type, 1 - Datalogger Example: 1 |
locationTime Time Stamp | Time of event Occurrence in ms Example: 1731400024000 |
messageIndex Integer | Represents a unique identifier for the specific message or data entry, allowing the system to track and reference this particular message within the data stream Example: 463148 |
partitionKey Integer | Unique identifier used to partition or organize data in the system Example: 5134555555 |
tripDistance Integer | Distance travelled in the current trip Example: 3 |
vendorTypeid Integer | ID of the Vendor type Example: 1 |
airFilterClog Boolean | Indicates whether the vehicle's air filter is clogged Example: false |
messageTypeId Integer | ID of the Message Type Example: 1 |
partialUpdate Boolean | Indicates whether the data has been partially updated Example: false |
clutchOverride Boolean | Indicates whether the clutch override feature is active Example: false |
deviceAvgSpeed Integer | The average speed of the device/vehicle in Kilometers per Hour Example: 18 |
deviceMaxSpeed Integer | The maximum speed the device/vehicle Example: 20 |
lowOilPressure Boolean | Indicates whether the vehicle is experiencing low oil pressure Example: false |
networkService Integer | Indicates the status of the network service Example: 0 |
satelliteCount Integer | The number of GPS satellites the device is currently connected to Example: 13 |
storedLocation Boolean | Indicates whether the device has stored a location Example: false |
tripIdlingTime Integer | The total amount of time the vehicle spent idling during the trip Example: 50 |
virtualTripEnd Boolean | Indicates whether the trip has ended virtually, meaning the system marks the end of the trip without the vehicle physically stopping. Example: false |
vehicleOdometer Boolean | Indicates whether the odometer reading for the vehicle is available Example: false |
privacyModeEnable Boolean | Indicates whether privacy mode is enabled on the device Example: false |
batteryDisonnected Boolean | Indicates whether the vehicle’s battery is disconnected Example: false |
batteryNotCharging Boolean | Indicates whether the vehicle’s battery is not charging Example: false |
Updated 5 days ago