GeofenceEntry Event Schema

Webhook payload schema for the GeofenceEntry event sent when a tracked asset enters a geofence.

Example

{
    "eventId": "017db07f-6e95-470e-8cc0-a371f9deed2b",
    "eventTime": "1970-01-20T06:39:05.683Z",
    "eventType": "GeofenceEntry",
    "orgId": 20936,
    "webhookId": "1411751028848270",
    "data": {
        "address": {
            "externalIds": {
                "siteId": "54"
            },
            "formattedAddress": "350 Rhode Island St, San Francisco, CA",
            "geofence": {
                "circle": {
                    "latitude": 37.7749,
                    "longitude": 137.7749,
                    "radiusMeters": 23
                },
                "polygon": {
                    "vertices": [
                        {
                            "latitude": 37.7749,
                            "longitude": 137.7749
                        },
                        {
                            "latitude": 37.7749,
                            "longitude": 137.7749
                        }
                    ]
                },
                "settings": {
                    "showAddresses": [
                        {
                            "latitude": 37.7749,
                            "longitude": 137.7749
                        },
                        {
                            "latitude": 37.7749,
                            "longitude": 137.7749
                        },
                        {
                            "latitude": 37.7749,
                            "longitude": 137.7749
                        },
                        {
                            "latitude": 37.7749,
                            "longitude": 137.7749
                        }
                    ]
                }
            },
            "id": "494123",
            "name": "Company Office #1"
        },
        "vehicle": {
            "assetType": "vehicle",
            "externalIds": {
                "maintenanceId": "250020"
            },
            "gateway": {
                "model": "VG34",
                "serial": "GFRV-43N-VGX"
            },
            "id": "494123",
            "licensePlate": "6SAM123",
            "name": "Fleet Truck #1",
            "vin": "1GBJ6P1B2HV112765"
        }
    }
}

##Reference

Property Name	Description
address object	A minimal Address object representation used in AddressEventObject objects
externalIds     object	A map of external ids
formattedAddress     string	The full street address for this address/geofence, as it might be recognized by Google Maps.
geofence     object	The geofence that defines this address and its bounds. This can either be a circle or a polygon, but not both.
circle         object	Information about a circular geofence. This field is only needed if the geofence is a circle.
latitude             number	Latitude of the address. Will be geocoded from formattedAddress if not provided.
longitude             number	Longitude of the address. Will be geocoded from formattedAddress if not provided.
radiusMeters             integer	The radius of the circular geofence in meters.
polygon         object	Information about a polygon geofence. This field is only needed if the geofence is a polygon.
vertices             object array	The vertices of the polygon geofence. These geofence vertices describe the perimeter of the polygon, and must consist of at least 3 vertices and less than 40.
latitude                 number	The latitude of a geofence vertex in decimal degrees.
longitude                 number	The longitude of a geofence vertex in decimal degrees.
settings         object	Information about a geofence settings.
showAddresses             object array	The geofence setting. If this setting set to true, then underlying geofence addresses will be shown in reports instead of a geofence’s name.
latitude                 number	The latitude of a geofence vertex in decimal degrees.
longitude                 number	The longitude of a geofence vertex in decimal degrees.
id     string	Id of the address
name     string	Name of the address
vehicle object	A minified vehicle object. This object is only returned if the route is assigned to the vehicle.
assetType     string	The type of the asset. Valid values: uncategorized, trailer, equipment, unpowered, vehicle.
externalIds     object	A map of external ids
gateway     object	A minified gateway object
model         string	The model of the gateway installed on the asset. Valid values: AG15, AG24, AG24EU, AG26, AG26EU, AG41, AG41EU, AG45, AG45EU, AG46, AG46EU, AG46P, AG46PEU, AG51, AG51EU, AG52, AG52EU, AG53, AG53EU, IG15, IG21, IG41, IG61, SG1, SG1B, SG1G, SG1G32, SG1x, VG32, VG33, VG34, VG34EU, VG34FN, VG34M, VG54ATT, VG54EU, VG54FN, VG54NA, VG54NAE, VG54NAH, VG55EU, VG55FN, VG55NA.
serial         string	The serial number of the gateway installed on the asset.
id     string	ID of the vehicle
licensePlate     string	The license plate of the vehicle.
name     string	Name of the vehicle
vin     string	The VIN of the vehicle.