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.
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",
"device_id": "h9v1j-51p5d-pqv5p-b4q33-h283d",
"device_type": "VEHICLE",
"failed_reason": null,
"id": "h283d-h9v1j-51p5d-pqv5p-b4q33",
"status": "EXECUTED"
}deviceType
string
id
string
Example 1
Example 2
Example 1 of 2
JSON
{
"device_type": "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"
}
}domain
RateLimitDomain
const
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"
}
}