[Beta] AddressCreated Event Schema
[Beta] AddressCreated Webhook Payload
Example
{
"eventId": "017db07f-6e95-470e-8cc0-a371f9deed2b",
"eventTime": "1970-01-20T06:39:05.683Z",
"eventType": "AddressCreated",
"orgId": 20936,
"webhookId": "1411751028848270",
"data": {
"address": {
"addressTypes": [
"yard"
],
"contacts": [
{
"firstName": "Michael",
"id": "312312",
"lastName": "Johnson"
},
{
"firstName": "Michael",
"id": "312312",
"lastName": "Johnson"
},
{
"firstName": "Michael",
"id": "312312",
"lastName": "Johnson"
}
],
"createdAtTime": "2021-08-30T19:36:05+00:00",
"externalIds": {
"siteId": "54"
},
"formattedAddress": "298 Burnley St",
"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",
"latitude": 37.7749,
"longitude": 122.4194,
"name": "Company Office #1",
"notes": "This address is located at site 892.",
"tags": [
{
"id": "3914",
"name": "East Coast",
"parentTagId": "4815"
},
{
"id": "3914",
"name": "East Coast",
"parentTagId": "4815"
}
]
}
}
}
Reference
Property Name | Description |
---|---|
address object | Full Address object |
    addressTypes     string array | Reporting location type associated with the address (used for ELD reporting purposes). Valid values: yard, shortHaul, workforceSite, riskZone, industrialSite. |
    contacts     object array | An array of Contact mini-objects that are associated the Address. |
        firstName         string | First name of the contact. |
        id         string | ID of the contact. |
        lastName         string | Last name of the contact |
    createdAtTime     string | The date and time this address was created in RFC 3339 format. |
    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 |
    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. |
    name     string | Name of the address. |
    notes     string | Notes about the address. |
    tags     object array | The list of tags associated with the Trailer. |
        id         string | ID of the tag |
        name         string | Name of the tag. |
        parentTagId         string | If this tag is part a hierarchical tag tree, this is the ID of the parent tag, otherwise this will be omitted. |
Updated 4 days ago