[Open Beta] Event Subscriptions

Subscribe to events through webhooks

ūüöß

Beta Feature

This feature is currently in Open Beta, meaning it is subject to change before full release. Please do not build production code based on this documentation. Instead, use this documentation to test the feature and provide feedback.

We've heard your feedback on our Webhooks framework, and we've been working hard on some major improvements that make using webhooks easier and more robust!

  • We're allowing you to subscribe directly to Samsara platform events without having to create an Alert first.
  • We're releasing a Webhooks REST API that allows you to automate the process of managing your webhooks - complete with full CRUD support.
  • We're beefing up the webhook payloads to make sure you get as much useful data in the payload as possible.

If you're not familiar with our current webhooks framework, please read the Webhooks guide.

If you want to enable this feature, toggle this on for your Samsara Org via the Feature Management page.

Subscribing to events

You can now subscribe directly to Samsara platform events without having to create an Alert first.

Subscribing via the Dashboard

Visit the Webhooks page in Settings, and add events to an existing or new Webhook

Subscribing via API

Use the beta webhooks APIs to create webhook definitions and subscribe them to events.

For example, the following POST request creates a new webhook and subscribes it to the DocumentSubmitted event:

curl --request POST 'https://api.samsara.com/beta/webhooks' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Test Event Subscriptions",
    "url": "https://webhook.site/80f1fbfb-2721-4d7f-a8a6-ba314f0b6fed",
    "eventTypes": [
        "DocumentSubmitted"
    ]
}'

You can update the webhook's event subscriptions by using a PATCH request to update the eventTypes array. Note that PATCH requests replace the existing value for a given array, so you'll need to include the full list of desired subscriptions in the eventTypes array with each request. The example below adds the VehicleCreated event subscription to the webhook created above. (Note that we must still include the original DocumentSubmitted subscription as well).

curl --request PATCH 'https://api.samsara.com/beta/webhooks/<id>' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "eventTypes": [
        "DocumentSubmitted",
        "VehicleCreated"
    ]
}'

Event Schemas

DocumentSubmitted

Example

{
  "eventId": "132a37eb-2ab2-43ae-a51f-71ff66b26caf",
  "eventTime": "2021-09-02T20:20:23.855Z",
  "eventType": "DocumentSubmitted",
  "orgId": 53729,
  "webhookId": "7656825201720761",
  "data": {
    "document": {
      "driver": {
        "id": "1654973",
        "name": "Tyler Freckmann",
        "externalIds": {
          "routePlanningSystem": "driver1234"
        }
      },
      "id": "1654973_1630614023498",
      "createdAtTime": "2021-09-02T20:20:24.000Z",
      "updatedAtTime": "2021-09-02T20:20:24.000Z",
      "notes": "Notes value",
      "state": "submitted",
      "documentType": {
        "id": "a227c0fb-419a-4670-8552-a66fcfb9ffa9",
        "name": "Test DocumentSubmitted Event Subscription"
      },
      "vehicle": {
        "id": "281474977075805",
        "name": "Little Red",
        "externalIds": {
          "samsara.serial": "G9MTH7CNKZ",
          "samsara.vin": "JTMBK32V895081147"
        }
      },
      "fields": [
        {
          "value": {
            "numberValue": 1
          },
          "label": "Number Field",
          "type": "number"
        },
        {
          "value": {
            "stringValue": "Text value"
          },
          "label": "Text Field",
          "type": "string"
        },
        {
          "value": {
            "photoValue": [
              {
                "url": "",
                "id": "3344bc7f-9514-4407-81d1-bb5d7e427911"
              },
              {
                "url": "",
                "id": "9291912e-a9a0-4031-91fe-fadb5fb1f8c0"
              }
            ]
          },
          "label": "Photo Field",
          "type": "photo"
        },
        {
          "value": {
            "multipleChoiceValue": [
              {
                "selected": true,
                "value": "Yes"
              },
              {
                "selected": false,
                "value": "No"
              }
            ]
          },
          "label": "Multiple Choice Field",
          "type": "multipleChoice"
        },
        {
          "value": {
            "stringValue": "Yes conditional text value"
          },
          "label": "Yes Conditional Text Field",
          "type": "string"
        },
        {
          "value": {},
          "label": "No Conditional Text Field",
          "type": "string"
        },
        {
          "value": {
            "dateTimeValue": {
              "dateTime": "2021-09-02T20:18:22.924Z"
            }
          },
          "label": "DateTime Field",
          "type": "dateTime"
        },
        {
          "value": {
            "signatureValue": {
              "name": "Tyler Freckmann",
              "signedAtTime": "2021-09-02T20:18:34.813Z",
              "url": "",
              "id": "eb61026a-9590-4877-8d9f-924745680d05"
            }
          },
          "label": "Signature Field",
          "type": "signature"
        },
        {
          "value": {
            "scannedDocumentValue": [
              {
                "url": "",
                "id": "f1412eb1-de1a-41d6-b3da-bddb6c5feb30"
              },
              {
                "url": "",
                "id": "f0224883-bd5b-4368-b418-1b3dd84037f4"
              }
            ]
          },
          "label": "Document Scan Field",
          "type": "scannedDocument"
        },
        {
          "value": {
            "barcodeValue": [
              {
                "barcodeType": "org.iso.Code39",
                "barcodeValue": "019006203691"
              },
              {
                "barcodeType": "org.iso.Code39",
                "barcodeValue": "019006203691"
              }
            ]
          },
          "label": "Barcode Field",
          "type": "barcode"
        }
      ],
      "routeStop": {},
      "conditionalFieldSections": [
        {
          "triggeringFieldIndex": 3,
          "triggeringFieldValue": "Yes",
          "conditionalFieldFirstIndex": 4,
          "conditionalFieldLastIndex": 4
        },
        {
          "triggeringFieldIndex": 3,
          "triggeringFieldValue": "No",
          "conditionalFieldFirstIndex": 5,
          "conditionalFieldLastIndex": 5
        }
      ]
    }
  }
}

Document Submitted Reference

Property NameDescription
document
object
A single document.
    conditionalFieldSections
    object array
List of the document conditional field sections.
        conditionalFieldFirstIndex
        integer
The index of the first conditional field associated with the triggeringFieldValue in the fieldTypes list.
        conditionalFieldLastIndex
        integer
The index of the last conditional field associated with the triggeringFieldValue in the fieldTypes list.
        triggeringFieldIndex
        integer
The index of the multiple choice field in the fieldTypes list that triggers one or more conditional fields.
        triggeringFieldValue
        string
The multiple choice option value that triggers the conditional fields.
    createdAtTime
    string
Time the document was created in RFC 3339 format.
    documentType
    object
A minified document type object
        id
        string
ID of the document type.
        name
        string
Name of the document type.
    driver
    object
A minified driver object
        externalIds
        object
A map of external ids
        id
        string
ID of the driver
        name
        string
Name of the driver
    fields
    object array
The fields associated with this document.
        label
        string
The name of the field.
        type
        string
The type of field. Valid values: photo, string, number, multipleChoice, signature, dateTime, scannedDocument, barcode.
        value
        object
The value of the document field. The shape of value depends on the type.
            barcodeValue
            object array
The value of a barcode scanning field. Only present for barcode scanning fields.
                barcodeType
                string
The barcode type that was scanned.
                barcodeValue
                string
The captured barcode value.
            dateTimeValue
            object
The value of a date time field. Only present for date time fields.
                dateTime
                string
Date time value inin RFC 3339 format.
            multipleChoiceValue
            object array
The value of a multiple choice field. Only present for multiple choice fields.
                selected
                boolean
Boolean representing if the choice has been selected.
                value
                string
Description of the choice.
            numberValue
            number
The value of a number field. Only present for number fields.
            photoValue
            object array
The value of a photo field. Only present for photo fields.
                id
                string
Id of the photo.
                url
                string
Url of the photo.
            scannedDocumentValue
            object array
The value of a scanned document field. Only present for scanned document fields.
                id
                string
Id of the scanned document.
                url
                string
Url of the scanned document.
            signatureValue
            object
The value of a signature field. Only present for signature fields.
                id
                string
Id of the signature field.
                name
                string
Name of the signee for a signature field.
                signedAtTime
                string
Time the signature was captured in RFC 3339 format.
                url
                string
Url of a signature field's PNG signature image.
            stringValue
            string
The value of a string field. Only present for string fields.
    id
    string
Universally unique identifier for the document.
    name
    string
Name of the document.
    notes
    string
Notes on the document.
    routeStop
    object
A minified route stop object
        externalIds
        object
A map of external ids
        id
        string
Id of the route stop
        name
        string
Name of the route stop
    state
    string
The condition of the document created for the driver. Can be either Required or Submitted. Required documents are pre-populated documents for the Driver to fill out in the Driver App and have not yet been submitted. Submitted documents have been submitted by the driver in the Driver App. Archived documents have been archived by the admin in the cloud dashboard. Valid values: submitted, required, archived.
    updatedAtTime
    string
Time the document was updated in RFC 3339 format.
    vehicle
    object
A minified vehicle object
        externalIds
        object
A map of external ids
        id
        string
ID of the vehicle
        name
        string
Name of the vehicle

DriverCreated

Example

{
  "eventId": "12d2d30a-a67a-428d-b7ec-e80ce0b6525f",
  "eventTime": "2021-10-13T21:35:39.773Z",
  "eventType": "DriverUpdated",
  "orgId": 20936,
  "webhookId": "1411751028848270",
  "data": {
    "driver": {
      "id": "7532674",
      "name": "Webhook Test Driver Jo Driver",
      "externalIds": {
        "maintenance": "webhookTestValue1",
        "payroll": "webhookTestValue1"
      },
      "driverActivationStatus": "active",
      "staticAssignedVehicle": {
        "id": "281474978553169",
        "name": "Webhook Test Vehicle - Batman!"
      },
      "carrierSettings": {
        "homeTerminalAddress": "123 Main St, Mountain View, CA",
        "homeTerminalName": "webhook home terminal"
      },
      "eldAdverseWeatherExemptionEnabled": false,
      "eldBigDayExemptionEnabled": false,
      "eldExempt": false,
      "eldPcEnabled": false,
      "eldYmEnabled": false,
      "notes": "This is an updated driver for testing the webhooksv2 enrichment",
      "phone": "5555555555",
      "createdAtTime": "2021-10-06T17:47:28.106Z",
      "updatedAtTime": "2021-10-13T21:35:39.735Z",
      "licenseNumber": "7dtea77",
      "licenseState": "DE",
      "tags": [
        {
          "id": "953963",
          "name": "Young Presidents Test Tag"
        }
      ],
      "timezone": "America/Los_Angeles",
      "username": "webhooktestdriver"
    }
  }
}

Driver Created Reference

Property NameDescription
driver
object
A driver object
    attributes
    object array
[beta] Attributes associated with this entity.
        id
        string
The Samsara ID of the attribute
        name
        string
The name of the attribute
        numberValues
        number array
Number values that are associated with this attribute
        stringValues
        string array
String values that are associated with this attribute
    carrierSettings
    object
Carrier for a given driver. If the driver's carrier differs from the general organization's carrier settings, the override value is used.
        carrierName
        string
Carrier for a given driver.
        dotNumber
        integer
Carrier US DOT Number. If this differs from the general organization's settings, the override value is used.
        homeTerminalAddress
        string
Address of the place of business at which a driver ordinarily reports for work.
        homeTerminalName
        string
Name of the place of business at which a driver ordinarily reports for work.
        mainOfficeAddress
        string
Main office address for a given driver. If this differs from the general organization's settings, the override value is used.
    createdAtTime
    string
The date and time this driver was created in RFC 3339 format.
    currentIdCardCode
    string
The ID Card Code on the back of the physical card assigned to the driver. Contact Samsara if you would like to enable this feature.
    driverActivationStatus
    string
A value indicating whether the driver is active or deactivated. Valid values: active, deactivated.
    eldAdverseWeatherExemptionEnabled
    boolean
Flag indicating this driver may use Adverse Weather exemptions in ELD logs.
    eldBigDayExemptionEnabled
    boolean
Flag indicating this driver may use Big Day exemption in ELD logs.
    eldDayStartHour
    integer
0 indicating midnight-to-midnight ELD driving hours, 12 to indicate noon-to-noon driving hours.
    eldExempt
    boolean
Flag indicating this driver is exempt from the Electronic Logging Mandate.
    eldExemptReason
    string
Reason that this driver is exempt from the Electronic Logging Mandate (see eldExempt).
    eldPcEnabled
    boolean
Flag indicating this driver may select the Personal Conveyance duty status in ELD logs.
    eldYmEnabled
    boolean
Flag indicating this driver may select the Yard Move duty status in ELD logs.
    externalIds
    object
A map of external ids
    id
    string
ID of the driver
    licenseNumber
    string
Driver's state issued license number. The combination of this number and licenseState must be unique.
    licenseState
    string
Abbreviation of US state, Canadian province, or US territory that issued driver's license.
    locale
    string
Locale override (uncommon). These are specified by ISO 3166-2 country codes for supported locales. Valid values: us, at, be, ca, gb, fr, de, ie, it, lu, mx, nl, es, ch, pr.
    name
    string
Name of the driver
    notes
    string
Notes about the driver
    phone
    string
Phone number of the driver
    staticAssignedVehicle
    object
A minified vehicle object
        externalIds
        object
A map of external ids
        id
        string
ID of the vehicle
        name
        string
Name of the vehicle
    tachographCardNumber
    string
Driver's assigned tachograph card number (Europe specific).
    tags
    object array
The list of tags associated with the Driver.
        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.
    timezone
    string
Home terminal timezone, in order to indicate what time zone should be used to calculate the ELD logs. Driver timezones use IANA timezone database keys (e.g. America/Los_Angeles, America/New_York, Europe/London, etc.). You can find a mapping of common timezone formats to IANA timezone keys here.
    updatedAtTime
    string
The date and time this driver was last updated in RFC 3339 format.
    usDriverRulesetOverride
    object
US Driver Ruleset override for a given driver. If the driver is operating under a ruleset different from the organization default, the override is used. If the driver does not have an override ruleset set, the response will not include any usDriverRulesetOverride information.
        cycle
        string
The driver's working cycle. Valid values: USA Property (8/70), USA Property (7/60), USA Passenger (8/70), USA Passenger (7/60), Alaska Property (8/80), Alaska Property (7/70), Alaska Passenger (8/80), Alaska Passenger (7/70), California School/FLV (8/80), California Farm (8/112), California Property (8/80), California Flammable Liquid (8/80), California Passenger (8/80), California Motion Picture (8/80), Florida (8/80), Florida (7/70), Nebraska (8/80), Nebraska (7/70), North Carolina (8/80), North Carolina (7/70), Oklahoma (8/70), Oklahoma (7/60), Oregon (8/80), Oregon (7/70), South Carolina (8/80), South Carolina (7/70), Texas (7/70), Wisconsin (8/80), Wisconsin (7/70).
        restart
        string
Amount of time necessary for the driver to be resting in order to restart their cycle. Valid values: 34-hour Restart, 24-hour Restart, 36-hour Restart, 72-hour Restart, None.
        restbreak
        string
The restbreak required for this driver. Valid values: Property (off-duty/sleeper), California Mealbreak (off-duty/sleeper), None.
        usStateToOverride
        string
The jurisdiction of the ruleset applied to this driver. These are specified by either the ISO 3166-2 postal code for the supported US states, or empty string '' for US Federal Ruleset jurisdiction. Valid values: `, AK, CA, FL, NE, NC, OK, OR, SC, TX, WI`.
    username
    string
Driver's login username into the driver app. The username may not contain spaces or the '@' symbol. The username must be unique.
    vehicleGroupTag
    object
A minified tag object
        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.

DriverUpdated

Example

{
  "eventId": "12d2d30a-a67a-428d-b7ec-e80ce0b6525f",
  "eventTime": "2021-10-13T21:35:39.773Z",
  "eventType": "DriverUpdated",
  "orgId": 20936,
  "webhookId": "1411751028848270",
  "data": {
    "driver": {
      "id": "7532674",
      "name": "Webhook Test Driver Jo Driver",
      "externalIds": {
        "maintenance": "webhookTestValue1",
        "payroll": "webhookTestValue1"
      },
      "driverActivationStatus": "active",
      "staticAssignedVehicle": {
        "id": "281474978553169",
        "name": "Webhook Test Vehicle - Batman!"
      },
      "carrierSettings": {
        "homeTerminalAddress": "123 Main St, Mountain View, CA",
        "homeTerminalName": "webhook home terminal"
      },
      "eldAdverseWeatherExemptionEnabled": false,
      "eldBigDayExemptionEnabled": false,
      "eldExempt": false,
      "eldPcEnabled": false,
      "eldYmEnabled": false,
      "notes": "This is an updated driver for testing the webhooksv2 enrichment",
      "phone": "5555555555",
      "createdAtTime": "2021-10-06T17:47:28.106Z",
      "updatedAtTime": "2021-10-13T21:35:39.735Z",
      "licenseNumber": "7dtea77",
      "licenseState": "DE",
      "tags": [
        {
          "id": "953963",
          "name": "Young Presidents Test Tag"
        }
      ],
      "timezone": "America/Los_Angeles",
      "username": "webhooktestdriver"
    }
  }
}

Driver Updated Reference

Property NameDescription
driver
object
A driver object
    attributes
    object array
[beta] Attributes associated with this entity.
        id
        string
The Samsara ID of the attribute
        name
        string
The name of the attribute
        numberValues
        number array
Number values that are associated with this attribute
        stringValues
        string array
String values that are associated with this attribute
    carrierSettings
    object
Carrier for a given driver. If the driver's carrier differs from the general organization's carrier settings, the override value is used.
        carrierName
        string
Carrier for a given driver.
        dotNumber
        integer
Carrier US DOT Number. If this differs from the general organization's settings, the override value is used.
        homeTerminalAddress
        string
Address of the place of business at which a driver ordinarily reports for work.
        homeTerminalName
        string
Name of the place of business at which a driver ordinarily reports for work.
        mainOfficeAddress
        string
Main office address for a given driver. If this differs from the general organization's settings, the override value is used.
    createdAtTime
    string
The date and time this driver was created in RFC 3339 format.
    currentIdCardCode
    string
The ID Card Code on the back of the physical card assigned to the driver. Contact Samsara if you would like to enable this feature.
    driverActivationStatus
    string
A value indicating whether the driver is active or deactivated. Valid values: active, deactivated.
    eldAdverseWeatherExemptionEnabled
    boolean
Flag indicating this driver may use Adverse Weather exemptions in ELD logs.
    eldBigDayExemptionEnabled
    boolean
Flag indicating this driver may use Big Day exemption in ELD logs.
    eldDayStartHour
    integer
0 indicating midnight-to-midnight ELD driving hours, 12 to indicate noon-to-noon driving hours.
    eldExempt
    boolean
Flag indicating this driver is exempt from the Electronic Logging Mandate.
    eldExemptReason
    string
Reason that this driver is exempt from the Electronic Logging Mandate (see eldExempt).
    eldPcEnabled
    boolean
Flag indicating this driver may select the Personal Conveyance duty status in ELD logs.
    eldYmEnabled
    boolean
Flag indicating this driver may select the Yard Move duty status in ELD logs.
    externalIds
    object
A map of external ids
    id
    string
ID of the driver
    licenseNumber
    string
Driver's state issued license number. The combination of this number and licenseState must be unique.
    licenseState
    string
Abbreviation of US state, Canadian province, or US territory that issued driver's license.
    locale
    string
Locale override (uncommon). These are specified by ISO 3166-2 country codes for supported locales. Valid values: us, at, be, ca, gb, fr, de, ie, it, lu, mx, nl, es, ch, pr.
    name
    string
Name of the driver
    notes
    string
Notes about the driver
    phone
    string
Phone number of the driver
    staticAssignedVehicle
    object
A minified vehicle object
        externalIds
        object
A map of external ids
        id
        string
ID of the vehicle
        name
        string
Name of the vehicle
    tachographCardNumber
    string
Driver's assigned tachograph card number (Europe specific).
    tags
    object array
The list of tags associated with the Driver.
        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.
    timezone
    string
Home terminal timezone, in order to indicate what time zone should be used to calculate the ELD logs. Driver timezones use IANA timezone database keys (e.g. America/Los_Angeles, America/New_York, Europe/London, etc.). You can find a mapping of common timezone formats to IANA timezone keys here.
    updatedAtTime
    string
The date and time this driver was last updated in RFC 3339 format.
    usDriverRulesetOverride
    object
US Driver Ruleset override for a given driver. If the driver is operating under a ruleset different from the organization default, the override is used. If the driver does not have an override ruleset set, the response will not include any usDriverRulesetOverride information.
        cycle
        string
The driver's working cycle. Valid values: USA Property (8/70), USA Property (7/60), USA Passenger (8/70), USA Passenger (7/60), Alaska Property (8/80), Alaska Property (7/70), Alaska Passenger (8/80), Alaska Passenger (7/70), California School/FLV (8/80), California Farm (8/112), California Property (8/80), California Flammable Liquid (8/80), California Passenger (8/80), California Motion Picture (8/80), Florida (8/80), Florida (7/70), Nebraska (8/80), Nebraska (7/70), North Carolina (8/80), North Carolina (7/70), Oklahoma (8/70), Oklahoma (7/60), Oregon (8/80), Oregon (7/70), South Carolina (8/80), South Carolina (7/70), Texas (7/70), Wisconsin (8/80), Wisconsin (7/70).
        restart
        string
Amount of time necessary for the driver to be resting in order to restart their cycle. Valid values: 34-hour Restart, 24-hour Restart, 36-hour Restart, 72-hour Restart, None.
        restbreak
        string
The restbreak required for this driver. Valid values: Property (off-duty/sleeper), California Mealbreak (off-duty/sleeper), None.
        usStateToOverride
        string
The jurisdiction of the ruleset applied to this driver. These are specified by either the ISO 3166-2 postal code for the supported US states, or empty string '' for US Federal Ruleset jurisdiction. Valid values: `, AK, CA, FL, NE, NC, OK, OR, SC, TX, WI`.
    username
    string
Driver's login username into the driver app. The username may not contain spaces or the '@' symbol. The username must be unique.
    vehicleGroupTag
    object
A minified tag object
        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.

VehicleCreated

Example

{
  "eventId": "ed3bcd22-395a-46d6-bc5c-c5d43c04bd17",
  "eventTime": "2021-08-05T17:46:49.000Z",
  "eventType": "VehicleCreated",
  "orgId": 9273,
  "webhookId": "9522784354509",
  "data": {
    "vehicle": {
      "id": "1234567890",
      "name": "Little Red",
      "vehicleVin": "ABC1234567890",
      "licensePlate": "CA1234ABCD",
      "gateway": {
        "serial": "GFRV-43N-VGX"
      }
    }
  }
}

Vehicle Created Reference

Property NameDescription
vehicle
object
A vehicle object
    externalIds
    object
A map of external ids
    gateway
    object
A minified gateway object
        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
    vehicleVin
    string
The VIN of the vehicle.

VehicleUpdated

Example

{
  "eventId": "3724e49d-ee97-4aa0-9232-7c8f5d6993f6",
  "eventTime": "2021-10-06T18:50:12.217Z",
  "eventType": "VehicleUpdated",
  "orgId": 20936,
  "webhookId": "1411751028848270",
  "data": {
    "vehicle": {
      "auxInputType1": "boom",
      "auxInputType2": "generator",
      "externalIds": {
        "maintenance": "webhookMaintenanceIdTest1",
        "samsara.serial": "GPT6CV7JHN",
        "samsara.vin": "NDNSNS"
      },
      "gateway": {
        "serial": "GPT6-CV7-JHN",
        "model": "VG34"
      },
      "harshAccelerationSettingType": "heavyDuty",
      "id": "281474978553169",
      "licensePlate": "7dtea77",
      "model": "VG34",
      "name": "Webhook Test Vehicle - Batman!",
      "notes": "this is a test of the webhooksv2 VehicleUpdated enrichment",
      "serial": "GPT6CV7JHN",
      "staticAssignedDriver": {
        "id": "7532674",
        "name": "Webhook Test Driver"
      },
      "tags": [
        {
          "id": "240997",
          "name": "Test-Tag"
        },
        {
          "id": "1677202",
          "name": "Tag-scoped Test",
          "parentTagId": "240997"
        }
      ],
      "vin": "NDNSNS",
      "vehicleRegulationMode": "regulated"
    }
  }
}

Vehicle Updated Reference

Property NameDescription
vehicle
object
A single vehicle
    attributes
    object array
List of attributes associated with the entity
        id
        string
Id of the attribute
        name
        string
Name of the attribute
        numberValues
        number array
List of number values associated with the attribute
        stringValues
        string array
List of string values associated with the attribute.
    auxInputType1
    string
The type of auxiliary input configured for this Vehicle.
    auxInputType10
    string
The type of auxiliary input configured for this Vehicle.
    auxInputType11
    string
The type of auxiliary input configured for this Vehicle.
    auxInputType12
    string
The type of auxiliary input configured for this Vehicle.
    auxInputType13
    string
The type of auxiliary input configured for this Vehicle.
    auxInputType2
    string
The type of auxiliary input configured for this Vehicle.
    auxInputType3
    string
The type of auxiliary input configured for this Vehicle.
    auxInputType4
    string
The type of auxiliary input configured for this Vehicle.
    auxInputType5
    string
The type of auxiliary input configured for this Vehicle.
    auxInputType6
    string
The type of auxiliary input configured for this Vehicle.
    auxInputType7
    string
The type of auxiliary input configured for this Vehicle.
    auxInputType8
    string
The type of auxiliary input configured for this Vehicle.
    auxInputType9
    string
The type of auxiliary input configured for this Vehicle.
    cameraSerial
    string
The serial number of the camera installed in the 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, IG15, IG21, IG41, IG61, SG1, VG32, VG33, VG34, VG34EU, VG34FN, VG54EU, VG54NA.
        serial
        string
The serial number of the gateway installed on the asset.
    harshAccelerationSettingType
    string
The harsh acceleration setting type.
    id
    string
ID of the vehicle
    licensePlate
    string
The license plate of the vehicle.
    make
    string
The Vehicle’s manufacturing make.
    model
    string
The Vehicle’s manufacturing model.
    name
    string
Name of the vehicle
    notes
    string
These are generic notes about the Vehicle.
    serial
    string
The serial number of the gateway installed in the vehicle.
    staticAssignedDriver
    object
A minified driver object.
        id
        string
ID of the driver.
        name
        string
Name of the driver.
    tags
    object array
The list of tags associated with the Vehicle.
        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.
    vehicleRegulationMode
    string
Whether the vehicle is regulated or unregulated (non-CMV). Valid values: regulated, unregulated.
    vin
    string
The VIN of the vehicle.
    year
    string

AddressCreated

Example

{
  "eventId": "017db07f-6e95-470e-8cc0-a371f9deed2b",
  "eventTime": "2021-10-11T20:34:43.728Z",
  "eventType": "AddressUpdated",
  "orgId": 20936,
  "webhookId": "1411751028848270",
  "data": {
    "address": {
      "addressTypes": [
        "yard"
      ],
      "createdAtTime": "2021-10-11 20:31:33.987687 +0000 UTC",
      "formattedAddress": "101 E San Fernando St, San Jose, CA 95112, USA",
      "geofence": {
        "circle": {
          "latitude": 37.3356988,
          "longitude": -121.8866697,
          "radiusMeters": 50
        }
      },
      "id": "26643821",
      "latitude": 37.3356988,
      "longitude": -121.8866697,
      "name": "New Name for Test Webhook API",
      "tags": [
        {
          "id": "953963",
          "name": "Young Presidents Test Tag"
        }
      ]
    }
  }
}

Address Created Reference

Property NameDescription
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.

AddressUpdated

Example

{
  "eventId": "017db07f-6e95-470e-8cc0-a371f9deed2b",
  "eventTime": "2021-10-11T20:34:43.728Z",
  "eventType": "AddressUpdated",
  "orgId": 20936,
  "webhookId": "1411751028848270",
  "data": {
    "address": {
      "addressTypes": [
        "yard"
      ],
      "createdAtTime": "2021-10-11 20:31:33.987687 +0000 UTC",
      "formattedAddress": "101 E San Fernando St, San Jose, CA 95112, USA",
      "geofence": {
        "circle": {
          "latitude": 37.3356988,
          "longitude": -121.8866697,
          "radiusMeters": 50
        }
      },
      "id": "26643821",
      "latitude": 37.3356988,
      "longitude": -121.8866697,
      "name": "New Name for Test Webhook API",
      "tags": [
        {
          "id": "953963",
          "name": "Young Presidents Test Tag"
        }
      ]
    }
  }
}

Address Updated Reference

Property NameDescription
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.

AddressDeleted

Example

{
  "eventId": "3f58a979-eaeb-4329-a787-ae623510d1f6",
  "eventTime": "2021-10-12T18:07:22.069Z",
  "eventType": "AddressDeleted",
  "orgId": 20936,
  "webhookId": "1411751028848270",
  "data": {
    "address": {
      "id": "26643821",
      "name": "New Name for Test Webhook API"
    }
  }
}

Address Deleted Reference

Property NameDescription
address
object
A minified Address object
    externalIds
    object
A map of external ids
    id
    string
Id of the address
    name
    string
Name of the address

DvirSubmitted

Example

{
  "eventId": "132a37eb-2ab2-43ae-a51f-71ff66b26caf",
  "eventTime": "2021-09-02T20:20:23.855Z",
  "eventType": "DvirSubmitted",
  "orgId": 53729,
  "webhookId": "7656825201720761",
  "data": {
    "dvir": {
      "id": "161047572",
      "authorSignature": {
        "type": "driver",
        "signedAtTime": "2022-03-04T20:17:57.000Z",
        "signatoryUser": {
          "id": "7023834",
          "name": "Tyler freckmann"
        }
      },
      "endTime": "2022-03-04T20:17:57.000Z",
      "formattedLocation": "123 Main St",
      "odometerMeters": 15251715,
      "safetyStatus": "safe",
      "startTime": "2022-03-04T20:13:40.374Z",
      "type": "preTrip",
      "vehicle": {
        "id": "281474978553169",
        "name": "Little Red",
        "externalIds": {
          "samsara.serial": "GPT6CV7JHN",
          "samsara.vin": "2C4GM68475R667819"
        },
        "vehicleVin": "2C4GM68475R667819",
        "licensePlate": "2teapls",
        "gateway": {
          "serial": "GPT6CV7JHN"
        }
      },
      "driver": {
        "id": "7023834",
        "name": "Tyler Freckmann"
      },
      "defects": [
        {
          "id": "5747482",
          "comment": "Right wiper missing",
          "createdAtTime": "2022-03-04T20:13:40.374Z",
          "defectType": "Windscreen wipers and washers",
          "isResolved": false,
          "vehicle": {
            "id": "281474978553169",
            "name": "Little Red",
            "externalIds": {
              "samsara.serial": "GPT6CV7JHN",
              "samsara.vin": "2C4GM68475R667819"
            },
            "vehicleVin": "2C4GM68475R667819",
            "licensePlate": "2teapls",
            "gateway": {
              "serial": "GPT6CV7JHN"
            }
          }
        },
        {
          "id": "5747483",
          "comment": "Deep abrasions on passenger door",
          "createdAtTime": "2022-03-04T20:13:40.374Z",
          "defectType": "Bodywork and doors",
          "isResolved": false,
          "vehicle": {
            "id": "281474978553169",
            "name": "Little Red",
            "externalIds": {
              "samsara.serial": "GPT6CV7JHN",
              "samsara.vin": "2C4GM68475R667819"
            },
            "vehicleVin": "2C4GM68475R667819",
            "licensePlate": "2teapls",
            "gateway": {
              "serial": "GPT6CV7JHN"
            }
          }
        },
        {
          "id": "5747484",
          "comment": "Overly enthusiastic",
          "createdAtTime": "2022-03-04T20:13:40.374Z",
          "defectType": "Horn",
          "isResolved": false,
          "vehicle": {
            "id": "281474978553169",
            "name": "Little Red",
            "externalIds": {
              "samsara.serial": "GPT6CV7JHN",
              "samsara.vin": "2C4GM68475R667819"
            },
            "vehicleVin": "2C4GM68475R667819",
            "licensePlate": "2teapls",
            "gateway": {
              "serial": "GPT6CV7JHN"
            }
          }
        }
      ],
      "hasDefects": true,
      "needsCorrection": false
    }
  }
}

DVIR Submitted Reference

Property NameDescription
dvir
object
A DVIR description
    authorSignature
    object
An author signature for DVIRs with a signed time.
        signatoryUser
        object
The user who signed the DVIR.
            id
            string
ID of the user.
            name
            string
Name of the user.
        signedAtTime
        string
The time when the DVIR was signed. UTC timestamp in RFC 3339 format.
        type
        string
Whether the DVIR was submitted by a driver or mechanic. Valid values: driver, mechanic.
    defects
    object array
Defects registered for the DVIR.
        comment
        string
Comment on the defect.
        createdAtTime
        string
Time when the defect was created. UTC timestamp in RFC 3339 format.
        defectType
        string
The type of DVIR defect.
        id
        string
The ID of the defect.
        isResolved
        boolean
Signifies if this defect is resolved.
        mechanicNotes
        string
The mechanic notes on this defect.
        mechanicNotesUpdatedAtTime
        string
Time when mechanic notes were last updated. UTC timestamp in RFC 3339 format.
        resolvedAtTime
        string
Time when this defect was resolved. Will not be returned if the defect is unresolved. UTC timestamp in RFC 3339 format.
        resolvedBy
        object
The person who resolved this defect.
            id
            string
ID of the entity that resolved this defect. If the defect was resolved by a driver, this will be a Samsara Driver ID. If the defect was resolved by a mechanic, this will be the Samsara Dashboard User ID of the mechanic.
            name
            string
Name of the person who resolved this defect.
            type
            string
Indicates whether this defect was resolved by a driver or a mechanic. Valid values: driver, mechanic.
        trailer
        object
A minified trailer object
            externalIds
            object
A map of external ids
            id
            string
ID of the trailer
            name
            string
Name of the trailer
        vehicle
        object
A vehicle object
            externalIds
            object
A map of external ids
            gateway
            object
A minified gateway object
                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
            vehicleVin
            string
The VIN of the vehicle.
    driver
    object
A minified driver object
        externalIds
        object
A map of external ids
        id
        string
ID of the driver
        name
        string
Name of the driver
    endTime
    string
Time when the driver signed and completed this DVIR. UTC timestamp in RFC 3339 format.
    formattedLocation
    string
Optional string if your jurisdiction requires a location of the DVIR.
    hasDefects
    boolean
Indicates if a defect is present on the DVIR.
    id
    string
The unique id of the DVIR
    mechanicNotes
    string
The mechanics notes on the DVIR.
    needsCorrection
    boolean
Indicates if a defect needs correction.
    odometerMeters
    integer
The odometer reading in meters.
    safetyStatus
    string
The condition of vehicle on which DVIR was done. Valid values: safe, unsafe, resolved.
    secondSignature
    object
An author signature for DVIRs with a signed time.
        signatoryUser
        object
The user who signed the DVIR.
            id
            string
ID of the user.
            name
            string
Name of the user.
        signedAtTime
        string
The time when the DVIR was signed. UTC timestamp in RFC 3339 format.
        type
        string
Whether the DVIR was submitted by a driver or mechanic. Valid values: driver, mechanic.
    startTime
    string
Time when driver began filling out this DVIR in RFC 3339 format.
    thirdSignature
    object
An author signature for DVIRs with a signed time.
        signatoryUser
        object
The user who signed the DVIR.
            id
            string
ID of the user.
            name
            string
Name of the user.
        signedAtTime
        string
The time when the DVIR was signed. UTC timestamp in RFC 3339 format.
        type
        string
Whether the DVIR was submitted by a driver or mechanic. Valid values: driver, mechanic.
    trailer
    object
A minified trailer object
        externalIds
        object
A map of external ids
        id
        string
ID of the trailer
        name
        string
Name of the trailer
    type
    string
Inspection type of the DVIR. Valid values: preTrip, postTrip, mechanic, unspecified.
    vehicle
    object
A vehicle object
        externalIds
        object
A map of external ids
        gateway
        object
A minified gateway object
            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
        vehicleVin
        string
The VIN of the vehicle.

EngineFaultOff

Example

{
    "eventId": "132a37eb-2ab2-43ae-a51f-71ff66b26caf",
    "eventTime": "2021-09-02T20:20:23.855Z",
    "eventType": "EngineFaultOff",
    "orgId": 53729,
    "webhookId": "7656825201720761",
    "data": {
        "fault": {
            "j1939": {
                "fmi": {
                    "description": "Description",
                    "id": "1"
                },
                "lamps": {
                    "emissions": true,
                    "protect": true,
                    "stop": true,
                    "warning": true
                },
                "occurrenceCount": 1,
                "spn": {
                    "description": "Description",
                    "id": "1"
                },
                "txId": "1",
                "vendorDtcDescription": "Description",
                "volvoRepairInstructions": "https://www.volvo.com"
            },
            "oem": {
                "codeDescription": "KVGT Servo Error",
                "codeIdentifier": "CA2387",
                "codeSeverity": "L03",
                "codeSource": "ENG/M"
            },
            "passenger": {
                "dtc": {
                    "description": "Description",
                    "shortCode": "Short Code",
                    "troubleCode": 1
                },
                "lamps": {
                    "emissions": true
                }
            }
        },
        "vehicle": {
            "externalIds": {
                "maintenanceId": "250020",
                "payrollId": "ABFS18600"
            },
            "id": "494123",
            "name": "Fleet Truck #1"
        }
    }
}

Engine Fault Off Reference

Property NameDescription
fault
object
Faults are triggered when there are malfunctions in a vehicle or heavy equipment.
    j1939
    object
J1939 Fault
        fmi
        object
FMI
            description
            string
Description of FMI
            id
            string
FMI ID
        lamps
        object
Lamp statuses for J1939
            emissions
            boolean
The emissions lamp is involved in this fault.
            protect
            boolean
The protect lamp is involved in this fault.
            stop
            boolean
The stop lamp is involved in this fault.
            warning
            boolean
The warning lamp is involved in this fault.
        occurrenceCount
        integer
Number of occurrences
        spn
        object
SPN
            description
            string
Description of SPN
            id
            string
SPN ID
        txId
        string
txId
        vendorDtcDescription
        string
Vendor DTC Description
        volvoRepairInstructions
        string
URL for Volvo Repair Instructions
    oem
    object
OEM Fault
        codeDescription
        string
The OEM code description.
        codeIdentifier
        string
The OEM code identifier.
        codeSeverity
        string
The OEM code severity.
        codeSource
        string
The OEM code source.
    passenger
    object
Passenger Fault
        dtc
        object
DTC
            description
            string
Description of DTC
            shortCode
            string
Short Code for DTC
            troubleCode
            integer
Trouble Code
        lamps
        object
Lamp statuses for Passenger
            emissions
            boolean
The emissions lamp is involved in this fault.
vehicle
object
A minified vehicle object
    externalIds
    object
A map of external ids
    id
    string
ID of the vehicle
    name
    string
Name of the vehicle

EngineFaultOn

Example

{
    "eventId": "132a37eb-2ab2-43ae-a51f-71ff66b26caf",
    "eventTime": "2021-09-02T20:20:23.855Z",
    "eventType": "EngineFaultOn",
    "orgId": 53729,
    "webhookId": "7656825201720761",
    "data": {
        "fault": {
            "j1939": {
                "fmi": {
                    "description": "Description",
                    "id": "1"
                },
                "lamps": {
                    "emissions": true,
                    "protect": true,
                    "stop": true,
                    "warning": true
                },
                "occurrenceCount": 1,
                "spn": {
                    "description": "Description",
                    "id": "1"
                },
                "txId": "1",
                "vendorDtcDescription": "Description",
                "volvoRepairInstructions": "https://www.volvo.com"
            },
            "oem": {
                "codeDescription": "KVGT Servo Error",
                "codeIdentifier": "CA2387",
                "codeSeverity": "L03",
                "codeSource": "ENG/M"
            },
            "passenger": {
                "dtc": {
                    "description": "Description",
                    "shortCode": "Short Code",
                    "troubleCode": 1
                },
                "lamps": {
                    "emissions": true
                }
            }
        },
        "vehicle": {
            "externalIds": {
                "maintenanceId": "250020",
                "payrollId": "ABFS18600"
            },
            "id": "494123",
            "name": "Fleet Truck #1"
        }
    }
}

Engine Fault On Reference

Property NameDescription
fault
object
Faults are triggered when there are malfunctions in a vehicle or heavy equipment.
    j1939
    object
J1939 Fault
        fmi
        object
FMI
            description
            string
Description of FMI
            id
            string
FMI ID
        lamps
        object
Lamp statuses for J1939
            emissions
            boolean
The emissions lamp is involved in this fault.
            protect
            boolean
The protect lamp is involved in this fault.
            stop
            boolean
The stop lamp is involved in this fault.
            warning
            boolean
The warning lamp is involved in this fault.
        occurrenceCount
        integer
Number of occurrences
        spn
        object
SPN
            description
            string
Description of SPN
            id
            string
SPN ID
        txId
        string
txId
        vendorDtcDescription
        string
Vendor DTC Description
        volvoRepairInstructions
        string
URL for Volvo Repair Instructions
    oem
    object
OEM Fault
        codeDescription
        string
The OEM code description.
        codeIdentifier
        string
The OEM code identifier.
        codeSeverity
        string
The OEM code severity.
        codeSource
        string
The OEM code source.
    passenger
    object
Passenger Fault
        dtc
        object
DTC
            description
            string
Description of DTC
            shortCode
            string
Short Code for DTC
            troubleCode
            integer
Trouble Code
        lamps
        object
Lamp statuses for Passenger
            emissions
            boolean
The emissions lamp is involved in this fault.
vehicle
object
A minified vehicle object
    externalIds
    object
A map of external ids
    id
    string
ID of the vehicle
    name
    string
Name of the vehicle

GatewayUnplugged

Example

{
    "eventId": "132a37eb-2ab2-43ae-a51f-71ff66b26caf",
    "eventTime": "2021-09-02T20:20:23.855Z",
    "eventType": "GatewayUnplugged",
    "orgId": 53729,
    "webhookId": "7656825201720761",
    "data": {
        "gateway": {
            "model": "VG34",
            "serial": "GFRV-43N-VGX",
            "vehicle": {
                "externalIds": {
                    "maintenanceId": "250020",
                    "payrollId": "ABFS18600"
                },
                "id": "494123",
                "name": "Fleet Truck #1"
            }
        }
    }
}

Gateway Unplugged Reference

Property NameDescription
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, IG15, IG21, IG41, IG61, SG1, VG32, VG33, VG34, VG34EU, VG34FN, VG54EU, VG54NA.
    serial
    string
The serial number of the gateway installed on the asset.
    vehicle
    object
A minified vehicle object
        externalIds
        object
A map of external ids
        id
        string
ID of the vehicle
        name
        string
Name of the vehicle

GeofenceEntry

Example

{
    "eventId": "132a37eb-2ab2-43ae-a51f-71ff66b26caf",
    "eventTime": "2021-09-02T20:20:23.855Z",
    "eventType": "GeofenceEntry",
    "orgId": 53729,
    "webhookId": "7656825201720761",
    "data": {
        "address": {
            "externalIds": {
                "maintenanceId": "250020",
                "payrollId": "ABFS18600"
            },
            "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
                        },
                        {
                            "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": {
            "externalIds": {
                "maintenanceId": "250020",
                "payrollId": "ABFS18600"
            },
            "id": "494123",
            "licensePlate": "6SAM123",
            "name": "Fleet Truck #1",
            "vehicleVin": "1GBJ6P1B2HV112765"
        }
    }
}

Geofence Entry Reference

Property NameDescription
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 vehicle object
    externalIds
    object
A map of external ids
    id
    string
ID of the vehicle
    licensePlate
    string
The license plate of the vehicle.
    name
    string
Name of the vehicle
    vehicleVin
    string
The VIN of the vehicle.

GeofenceExit

Example

{
    "eventId": "132a37eb-2ab2-43ae-a51f-71ff66b26caf",
    "eventTime": "2021-09-02T20:20:23.855Z",
    "eventType": "GeofenceExit",
    "orgId": 53729,
    "webhookId": "7656825201720761",
    "data": {
        "address": {
            "externalIds": {
                "maintenanceId": "250020",
                "payrollId": "ABFS18600"
            },
            "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
                        },
                        {
                            "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": {
            "externalIds": {
                "maintenanceId": "250020",
                "payrollId": "ABFS18600"
            },
            "id": "494123",
            "licensePlate": "6SAM123",
            "name": "Fleet Truck #1",
            "vehicleVin": "1GBJ6P1B2HV112765"
        }
    }
}

Geofence Exit Reference

Property NameDescription
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 vehicle object
    externalIds
    object
A map of external ids
    id
    string
ID of the vehicle
    licensePlate
    string
The license plate of the vehicle.
    name
    string
Name of the vehicle
    vehicleVin
    string
The VIN of the vehicle.

Did this page help you?