Volteras Webhook Event Types
This is the list of event types that we currently send.
For guidance on how to listen to these events, take a look at Svix's guide to consuming webhooks.
alertDefinitionId
string
createdAt
string
(date-time)
currentSeverity
anyOf
definition
AlertDefinitionBase
5 Items
id
string
metadata
AlertMetadata
2 Items
muted
boolean
oemDeviceId
string
resolutions
array[]
status
AlertStatus
vin
anyOf
OptionalExample 1
Example 2
Example 3
Example 1 of 3
JSON
{
"alertDefinitionId": "h9v1j-51p5d-pqv5p-b4q33-h283d",
"createdAt": "2024-01-15T10:30:00Z",
"currentSeverity": "HIGH",
"definition": {
"category": {
"description": "Battery-related alerts",
"id": "hpqv5p-b4q33-h283d-h9v1j-51p5d",
"name": "Battery"
},
"description": "Battery management system has detected a fault",
"id": "h51p5d-pqv5p-b4q33-h283d-h9v1j",
"message": "Battery system requires service",
"name": "Battery Management System Fault"
},
"id": "h283d-h9v1j-51p5d-pqv5p-b4q33",
"metadata": {
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:35:00Z"
},
"muted": false,
"oemDeviceId": "h51p5d-pqv5p-b4q33-h283d-h9v1j",
"resolutions": [
{
"definition": {
"description": "Schedule service appointment for battery inspection",
"id": "hb4q33-h283d-h9v1j-51p5d-pqv5p",
"name": "Battery Service Required"
},
"id": "hpqv5p-b4q33-h283d-h9v1j-51p5d",
"status": "PENDING",
"steps": [
{
"definition": {
"description": "Contact service center",
"id": "h9v1j-51p5d-pqv5p-b4q33-h283d",
"order": 1
},
"id": "hh283d-h9v1j-51p5d-pqv5p-b4q33",
"status": "PENDING"
}
]
}
],
"status": "ACTIVE",
"vin": "WBYF2AW010FN82675"
}command
VehicleCommandEnum
Enum for available commands.
deviceId
string
deviceType
string
failedReason
anyOf
Optionalid
string
status
OEMDeviceCommandExecutionStatus
Enum for command execution status.
Example 1
Example 2
Example 3
Example 4
Example 5
Example 1 of 5
JSON
{
"command": "START_CHARGING",
"deviceId": "h9v1j-51p5d-pqv5p-b4q33-h283d",
"deviceType": "VEHICLE",
"failedReason": null,
"id": "h283d-h9v1j-51p5d-pqv5p-b4q33",
"status": "EXECUTED"
}deviceType
string
id
string
Example DeviceConnectedPayload
JSON
{
"deviceType": "VEHICLE",
"id": "h283d-h9v1j-51p5d-pqv5p-b4q33"
}deviceType
string
id
string
vin
anyOf
OptionalExample DeviceDisconnectedPayload
JSON
{
"deviceType": "VEHICLE",
"id": "h283d-h9v1j-51p5d-pqv5p-b4q33"
}root
oneOf
OptionalExample 1
Example 2
Example 3
Example 4
Example 5
Example 6
Example 7
Example 8
Example 9
Example 10
Example 1 of 10
JSON
{
"metricType": "STATE_OF_CHARGE",
"stateOfCharge": {
"unit": "percent",
"value": 85.5
},
"timestamp": "2024-01-15T10:30:00Z",
"vehicle": {
"id": "h283d-h9v1j-51p5d-pqv5p-b4q33",
"vin": "WBYF2AW010FN82675"
}
}distanceTravelledKm
anyOf
OptionalenergyEndKwh
anyOf
OptionalenergyStartKwh
anyOf
OptionalenergyUsedKwh
anyOf
Optionalid
string
odometerEnd
anyOf
OptionalodometerStart
anyOf
OptionalsocEnd
anyOf
OptionalsocStart
anyOf
OptionalsocUsed
anyOf
OptionalstartLatitude
anyOf
OptionalstartLongitude
anyOf
OptionalstartTimestamp
string
(date-time)
stopLatitude
anyOf
OptionalstopLongitude
anyOf
OptionalstopTimestamp
anyOf
OptionalvehicleId
string
vin
string
Example 1
Example 2
Example 3
Example 4
Example 1 of 4
JSON
{
"distanceTravelledKm": 25.5,
"energyEndKwh": 59.8,
"energyStartKwh": 65,
"energyUsedKwh": 5.2,
"id": "h283d-h9v1j-51p5d-pqv5p-b4q33",
"odometerEnd": 45255.5,
"odometerStart": 45230,
"socEnd": 77,
"socStart": 85,
"socUsed": 8,
"startLatitude": 37.7749,
"startLongitude": -122.4194,
"startTimestamp": "2024-01-15T10:00:00Z",
"stopLatitude": 37.7849,
"stopLongitude": -122.4094,
"stopTimestamp": "2024-01-15T10:35:00Z",
"vehicleId": "h9v1j-51p5d-pqv5p-b4q33-h283d",
"vin": "WBYF2AW010FN82675"
}domain
RateLimitDomain
key
RateLimitKey
maxRequests
integer
objectId
string
remainingRequests
integer
windowSizeSeconds
integer
Example 1
Example 2
Example 1 of 2
JSON
{
"domain": "VEHICLE",
"key": "BMW_ENERGY_API_COMMANDS",
"max_requests": 100,
"object_id": "h283d-h9v1j-51p5d-pqv5p-b4q33",
"remaining_requests": 10,
"window_size_seconds": 3600
}deviceType
string
id
string
Example DeviceConnectedPayload
JSON
{
"deviceType": "VEHICLE",
"id": "uuid-of-vehicle"
}DeviceTelemetry
oneOf
OptionalExample DeviceTelemetry
JSON
{
"location": {
"unit": "degree",
"value": {
"latitude": 70.02323,
"longitude": 79.2323
}
},
"metricType": "LOCATION",
"timestamp": "2024-10-16T09:00:01Z",
"vehicle": {
"id": "uuid-of-vehicle",
"vin": "vehicle-vin"
}
}