ENTERED_GEOFENCE

The ENTERED_GEOFENCE event is used to notify when a vehicle enters a predefined geofence region, allowing users to track vehicle entry into specific areas.

Event Type: ENTERED_GEOFENCE

Trigger Condition

Subscription to the ENTERED_GEOFENCE event is mandatory. The event is triggered instantly when a vehicle crosses into the boundary of a created geofence region.

Example Payload

{
"inputBit7": 0,
"partialUpdate": false,
"inputBit4": 0,
"voiceCallActive": 0,
"inputBit3": 0,
"inputBit6": 0,
"inputBit5": 0,
"type": "GeoFenceMessageVO",
"deviceId": "e4c97790-14c3-11ed-9449-7dd6059504b4",
"networkService": 0,
"commStateConnected": 0,
"messageType": "ENTERED_GEOFENCE",
"messageIndex": null,
"dimentionFix": 0,
"lastKnownLon": 0,
"geoFenceType": null,
"inputBit0": 0,
"inputBit2": 0,
"id": "1c00c3dc-4c01-4616-9111-d904544d8dcc",
"state": null,
"inputBit1": 0,
"commStatusAvaliable": 0,
"locality": null,
"eventIndex": 0,
"assetNo": null,
"fixStatusCorrected": 0,
"deviceSerial": "9076501020",
"groupName": "Default Group",
"lastKnownTime": null,
"jmsType": "",
"vehicleName": "9076501020",
"deviceTypeId": 0,
"destinationQueues": null,
"city": null,
"latitude": null,
"unitStatus": 0,
"invalidFix": 0,
"dataService": 0,
"noOfAccums": 0,
"customerId": 15047,
"beaconMacAddress": null,
"tripNumber": 0,
"sensorValue": null,
"spare": 0,
"address": "Zaheerabad, Telangana, India",
"roaming": 0,
"messageEventType": null,
"stateId": 0,
"updateTime": null,
"userId": null,
"batteryPercentage": 0,
"currentState": 0,
"deviceProtocolMessageId": null,
"messageEventTypeId": 0,
"zipCode": null,
"country": null,
"deviceAssociatedVIN": null,
"beaconType": null,
"groupId": "559d6f4c-11bf-11ed-8895-27b5feb885d3",
"vendorTypeId": 0,
"firmwareVersion": null,
"fixStatuslastKnown": 0,
"fixStatusHistoric": 0,
"longitude": null,
"satellites": null,
"locationTime": 1664103664000,
"odometer": 0,
"offset": 0,
"sensorUnitVal": null,
"virtualTripEnd": false,
"imei_meid": null,
"insideHOO": true,
"eventInfo": null,
"timeOfFix": null,
"sensorNames": null,
"tripPolyline": null,
"lastKnownLat": 0,
"fixQuality": 0,
"unitStatusBit0": 0,
"unitStatusBit2": 0,
"unitStatusBit1": 0,
"unitStatusBit3": 0,
"storedLocation": false,
"protocolVersionIdChange": false,
"accumesList": null,
"accumulators": null,
"fixStatusPredict": 0,
"network3G": 0,
"lastKnownAddress": null,
"geoFenceAlertReason": null,
"privacyModeEnable": false,
"fixStatus": 0,
"vehicleId": "e4c9778f-14c3-11ed-9449-17f42fbb1b68",
"lastKnownFixQuality": 0,
"userName": null,
"fenceName": "fence zhb",
"tripState": null,
"messageTypeId": 0,
"obdSpeed": null,
"location": {
"latitude": 17.69014,
"longitude": 77.581301
},
"commonState": 0,
"carrierId": null
}

Reference

Field

Description

type
String

Message type.
Example: GeoFenceMessageVO

deviceId
String,UUID

Unique identifier of the device.
Example: e4c97790-14c3-11ed-9449-7dd6059504b4

messageType
String

Type of message.
Example: ENTERED_GEOFENCE

lastKnownLon
Double

Last known longitude in degrees.
Example: 0

geoFenceType
String (nullable)

Type of geofence.

id
String,UUID

Message unique ID.
Example: 1c00c3dc-4c01-4616-9111-d904544d8dcc

locality
String (nullable)

Locality or region.

assetNo
String (nullable)

Asset number.

deviceSerial
String

Serial number of the device.
Example: 9076501020

groupName
String

Name of the group.
Example: Default Group

vehicleName
String

Vehicle name.
Example: 9076501020

deviceTypeId
Integer

Type ID of the device.
Example: 0

city
String (nullable)

City name.

customerId
Integer

Unique Azuga Customer ID.
Example: 15047

tripNumber
Integer

Unique trip number.
Example: 0

address
String

Full address of the vehicle.
Example: Zaheerabad, Telangana, India

updateTime
Long (nullable)

Time the update occurred.

userId
String (nullable)

ID of the user.

messageEventTypeId
Integer

ID of the message event type.
Example: 0

zipCode
String (nullable)

ZIP code.

country
String (nullable)

Country name.

locationTime
Time Stamp

Timestamp of location data in milliseconds Example: 1664103664000

groupId
String,UUID

Unique Identifier of the Group.
Example: 559d6f4c-11bf-11ed-8895-27b5feb885d3

virtualTripEnd
Boolean

Indicates if the trip ended virtually.
Example: false

imei_meid
String (nullable)

IMEI or MEID of the device.

insideHOO
Boolean

Inside Hours of Operation.
Example: true

lastKnownLat
Double

Last known latitude in degrees.
Example: 0

storedLocation
Boolean

Indicates whether the location is stored.
Example: false

protocolVersionIdChange
Boolean

Indicates whether protocol version changed.
Example: false

privacyModeEnable
Boolean

Indicates if privacy mode is enabled.
Example: false

vehicleId
String,UUID

Unique Identifier of vehicle.
Example: e4c9778f-14c3-11ed-9449-17f42fbb1b68

fenceName
String

Name of the geofence.
Example: fence zhb

location
Location { latitude: 34.12 longitude: -82.14 }

Current location object of the vehicle

latitude*
Double

Latitude co-ordinate value in degrees Example: 17.69014

longitude
Double

Longitude co-ordinate value in degrees Example: 77.581301