Webhooks

Introduction

This document outlines the webhooks available for your integration, and how to use them. Webhooks are automated messages sent from our system to yours when a specific event occurs. The payload of each webhook is delivered in JSON format.

Using Webhooks

You can subscribe to the webhook events below by going to the webhook page in our Portal. We use the webhook platform svix, and the catalog on that Portal page allows you to:

Add your endpoint for each event you want to subscribe to
Get the secret key used to verify the payload for that event type (after you have added an endpoint, you will see the key at the bottom of the page)
Get the complete JSON schema for the event type, including examples (see below for schemas and examples as well)
Add rate limiting and filtering rules for the event type, and custom headers for each
Test sending example payloads (set to the correct schema) to your endpoints
View logs and webhook activity for each event type

For more details, see the Svix documentation, and for information on how to verify the payload, see the Svix verify docs.

Webhook Events

Here are the specific webhook events you can subscribe to.

1. `device.connected`

This event is triggered whenever a new device successfully connects to our platform. This is useful for tracking the provisioning and online status of your devices.

Schema

The complete JSON schema for this event is available here.

Example Payloads

{
  "id": "h283d-h9v1j-51p5d-pqv5p-b4q33",
  "deviceType": "VEHICLE",
  "timestamp": "2024-01-15T10:30:00Z"
}

2. `device.disconnected`

This event is triggered whenever a device disconnects from our platform. This is useful for tracking when devices go offline.

Schema

The complete JSON schema for this event is available here.

Example Payloads

{
  "id": "h283d-h9v1j-51p5d-pqv5p-b4q33",
  "deviceType": "VEHICLE",
  "vin": "WBYF2AW010FN82675",
  "timestamp": "2024-01-15T10:30:00Z"
}

3. `device.telemetry`

This event is used to send various types of data and metrics from a device. The specific data included in the payload is determined by the metricType field.

Schema

The complete JSON schema for this event is available here. The schema includes all supported metric types and their detailed field definitions.

Supported Metric Types

STATE_OF_CHARGE - Battery charge percentage
ENERGY_REMAINING - Remaining energy in kWh
LOCATION - Vehicle coordinates
ODOMETER - Total distance traveled
RANGE - Estimated remaining range
TIRES - Tire pressure data
OEM_ALERT - Diagnostic trouble codes. The mappedCode, affectedComponent, recommendedAction, type and severity fields use a fixed set of values, listed under OEM Alert Vocabulary.
CHARGING_STATE - Current charging status
DEPARTURE_TIMES - Scheduled departure times
CHARGING_WINDOWS - Scheduled charging windows
OTHER_CHARGING_DATA - Additional charging metrics
OTHER_LOCATION_DATA - Additional location metrics (speed, heading, elevation)

Example Payloads

{
  "metricType": "STATE_OF_CHARGE",
  "vehicle": {
    "id": "h283d-h9v1j-51p5d-pqv5p-b4q33",
    "vin": "WBYF2AW010FN82675"
  },
  "timestamp": "2024-01-15T10:30:00Z",
  "stateOfCharge": {
    "unit": "percent",
    "value": 85.5
  }
}

{
  "metricType": "ENERGY_REMAINING",
  "vehicle": {
    "id": "h9v1j-51p5d-pqv5p-b4q33-h283d",
    "vin": "WBYF2AW010FN82676"
  },
  "timestamp": "2024-01-15T10:30:00Z",
  "energyRemainingKwh": {
    "unit": "kwh",
    "value": 65.2
  }
}

{
  "metricType": "LOCATION",
  "vehicle": {
    "id": "h51p5d-pqv5p-b4q33-h283d-h9v1j",
    "vin": "WBYF2AW010FN82677"
  },
  "timestamp": "2024-01-15T10:30:00Z",
  "location": {
    "unit": "degree",
    "value": {
      "longitude": -122.4194,
      "latitude": 37.7749
    }
  }
}

{
  "metricType": "ODOMETER",
  "vehicle": {
    "id": "hpqv5p-b4q33-h283d-h9v1j-51p5d",
    "vin": "WBYF2AW010FN82678"
  },
  "timestamp": "2024-01-15T10:30:00Z",
  "odometer": {
    "unit": "km",
    "value": 45230.5
  }
}

{
  "metricType": "RANGE",
  "vehicle": {
    "id": "hb4q33-h283d-h9v1j-51p5d-pqv5p",
    "vin": "WBYF2AW010FN82679"
  },
  "timestamp": "2024-01-15T10:30:00Z",
  "range": {
    "unit": "km",
    "value": 320.8
  }
}

{
  "metricType": "TIRES",
  "vehicle": {
    "id": "hh283d-h9v1j-51p5d-pqv5p-b4q33",
    "vin": "WBYF2AW010FN82680"
  },
  "timestamp": "2024-01-15T10:30:00Z",
  "pressure": {
    "unit": "KPA",
    "value": 240.5
  },
  "position": "FRONT_LEFT"
}

{
  "metricType": "OEM_ALERT",
  "vehicle": {
    "id": "h283d-h9v1j-51p5d-pqv5p-b4q34",
    "vin": "WBYF2AW010FN82681"
  },
  "timestamp": "2024-01-15T10:30:00Z",
  "oemAlert": {
    "status": "ACTIVE",
    "oemCode": "BMS_001",
    "oemMessage": "Battery management system fault detected",
    "oemMetadata": {
      "errorCode": "0x1234",
      "subsystem": "battery"
    },
    "mappedMessage": "Battery system requires service",
    "severity": "HIGH",
    "mappedCode": "BATTERY_MONITORING_FAILED",
    "affectedComponent": "BATTERY",
    "recommendedAction": "SERVICE_REQUIRED",
    "type": "FAULT"
  }
}

{
  "metricType": "CHARGING_STATE",
  "vehicle": {
    "id": "h9v1j-51p5d-pqv5p-b4q33-h283e",
    "vin": "WBYF2AW010FN82682"
  },
  "timestamp": "2024-01-15T10:30:00Z",
  "state": "CHARGING"
}

{
  "metricType": "DEPARTURE_TIMES",
  "vehicle": {
    "id": "h51p5d-pqv5p-b4q33-h283d-h9v1k",
    "vin": "WBYF2AW010FN82683"
  },
  "timestamp": "2024-01-15T10:30:00Z",
  "departureTimes": [
    {
      "hour": 8,
      "minute": 30,
      "daysOfWeek": [
        "MONDAY",
        "TUESDAY",
        "WEDNESDAY",
        "THURSDAY",
        "FRIDAY"
      ],
      "localTimeOffset": 60
    },
    {
      "hour": 17,
      "minute": 0,
      "daysOfWeek": [
        "MONDAY",
        "TUESDAY",
        "WEDNESDAY",
        "THURSDAY",
        "FRIDAY"
      ],
      "localTimeOffset": 60
    }
  ]
}

{
  "metricType": "CHARGING_WINDOWS",
  "vehicle": {
    "id": "h51p5d-pqv5p-b4q33-h283d-h9v1l",
    "vin": "WBYF2AW010FN82685"
  },
  "timestamp": "2024-01-15T10:30:00Z",
  "chargingWindows": [
    {
      "startHour": 0,
      "startMinute": 30,
      "endHour": 5,
      "endMinute": 30,
      "daysOfWeek": [
        "MONDAY",
        "TUESDAY",
        "WEDNESDAY",
        "THURSDAY",
        "FRIDAY"
      ],
      "localTimeOffset": 60,
      "windowLocation": {
        "longitude": -0.1278,
        "latitude": 51.5074
      }
    }
  ]
}

{
  "metricType": "OTHER_CHARGING_DATA",
  "vehicle": {
    "id": "hpqv5p-b4q33-h283d-h9v1j-51p5e",
    "vin": "WBYF2AW010FN82684"
  },
  "timestamp": "2024-01-15T10:30:00Z",
  "data": [
    {
      "key": "maxStateOfCharge",
      "unit": "percent",
      "value": 90.0
    },
    {
      "key": "chargeRemainingTime",
      "unit": "minutes",
      "value": 45
    },
    {
      "key": "chargePowerLevel",
      "unit": "kw",
      "value": 11.0
    },
    {
      "key": "chargeCurrentLimit",
      "unit": "amps",
      "value": 32.0
    },
    {
      "key": "chargePortDoorOpen",
      "unit": "boolean",
      "value": false
    },
    {
      "key": "chargePortLatch",
      "value": "ENGAGED"
    }
  ]
}

{
  "metricType": "OTHER_LOCATION_DATA",
  "vehicle": {
    "id": "hb4q33-h283d-h9v1j-51p5d-pqv5q",
    "vin": "WBYF2AW010FN82686"
  },
  "data": [
    {
      "key": "speed",
      "unit": "m/s",
      "value": 13.4,
      "timestamp": "2024-01-15T10:30:00Z"
    },
    {
      "key": "headingDegrees",
      "unit": "degree",
      "value": 182.5,
      "timestamp": "2024-01-15T10:30:00Z"
    },
    {
      "key": "elevation",
      "unit": "m",
      "value": 35.0,
      "timestamp": "2024-01-15T10:30:00Z"
    }
  ]
}

4. `command.updated`

This event is triggered when a vehicle command’s status changes (e.g., from PENDING to EXECUTED or FAILED).

Schema

The complete JSON schema for this event is available here.

Example Payloads

{
  "id": "h283d-h9v1j-51p5d-pqv5p-b4q33",
  "deviceType": "VEHICLE",
  "deviceId": "h9v1j-51p5d-pqv5p-b4q33-h283d",
  "command": "START_CHARGING",
  "status": "EXECUTED",
  "failedReason": null,
  "timestamp": "2024-01-15T10:30:00Z"
}

{
  "id": "h9v1j-51p5d-pqv5p-b4q33-h283d",
  "deviceType": "VEHICLE",
  "deviceId": "h51p5d-pqv5p-b4q33-h283d-h9v1j",
  "command": "SET_TEMPERATURE",
  "status": "FAILED",
  "failedReason": "Vehicle not connected to network",
  "timestamp": "2024-01-15T10:30:00Z"
}

{
  "id": "h51p5d-pqv5p-b4q33-h283d-h9v1j",
  "deviceType": "VEHICLE",
  "deviceId": "hpqv5p-b4q33-h283d-h9v1j-51p5d",
  "command": "UNLOCK_DOORS",
  "status": "PENDING",
  "failedReason": null,
  "timestamp": "2024-01-15T10:30:00Z"
}

{
  "id": "hpqv5p-b4q33-h283d-h9v1j-51p5d",
  "deviceType": "VEHICLE",
  "deviceId": "hb4q33-h283d-h9v1j-51p5d-pqv5p",
  "command": "SET_CHARGE_LIMIT",
  "status": "EXECUTED",
  "failedReason": null,
  "timestamp": "2024-01-15T10:30:00Z"
}

{
  "id": "hb4q33-h283d-h9v1j-51p5d-pqv5p",
  "deviceType": "VEHICLE",
  "deviceId": "hh283d-h9v1j-51p5d-pqv5p-b4q33",
  "command": "OPEN_CHARGE_PORT",
  "status": "FAILED",
  "failedReason": "Charge port already open",
  "timestamp": "2024-01-15T10:30:00Z"
}

5. `rate_limit.updated`

This event is triggered when a rate limit is updated for an API endpoint or service.

Schema

The complete JSON schema for this event is available here.

Example Payloads

{
  "remainingRequests": 10,
  "maxRequests": 100,
  "domain": "VEHICLE",
  "windowSizeSeconds": 3600,
  "objectId": "h283d-h9v1j-51p5d-pqv5p-b4q33",
  "key": "BMW_ENERGY_API_COMMANDS",
  "timestamp": "2024-01-15T10:30:00Z"
}

{
  "remainingRequests": 10,
  "maxRequests": 100,
  "domain": "VEHICLE",
  "windowSizeSeconds": 3600,
  "objectId": "h283d-h9v1j-51p5d-pqv5p-b4q33",
  "key": "BMW_ENERGY_API_STOP_COMMANDS",
  "timestamp": "2024-01-15T10:30:00Z"
}

6. `alert.updated`

This event is triggered when a custom (as opposed to one directly sent from the device manufacturer) alert’s status, severity, or other properties change. Alerts can be created, resolved, muted, or have their severity updated.

Schema

The complete JSON schema for this event is available here.

`oemAlerts`

When the trigger that fired has conditions on OEM alerts (metadata.oemAlert.*), oemAlerts lists the vehicle’s active OEM alerts that satisfied them, most recent first, with one entry per oemCode. Each entry has the same shape as oemAlert on the OEM_ALERT metric type of device.telemetry, so it carries the manufacturer’s own oemCode, oemMessage and oemMetadata alongside the normalised fields listed under OEM Alert Vocabulary. An alert definition can watch for several faults, and more than one of them can be active at once, so every active OEM alert that satisfied the trigger is listed. That tells you which of the watched faults were present. Active OEM alerts the trigger doesn’t match are never included. oemAlerts reflects the vehicle’s active OEM alerts when the alert changed. A change in those OEM alerts on its own, while the alert stays the same, doesn’t send a new event. oemAlerts is null when the trigger that fired has no OEM alert conditions, such as an alert on a missing odometer reading, and in the rare case that the OEM alerts couldn’t be determined. Otherwise it’s a list, which can be empty when the trigger matched through its other conditions. oemAlerts is only sent on this webhook, and isn’t returned by GET /vehicles/{id}/alerts. oemAlerts is null on a RESOLVED event, as are currentSeverity, triggerName and triggerDescription, because an alert resolves when none of its triggers match any more. Correlate a RESOLVED event with the earlier ACTIVE one using the alert id.

Example Payloads

{
  "id": "h283d-h9v1j-51p5d-pqv5p-b4q33",
  "status": "ACTIVE",
  "alertDefinitionId": "h9v1j-51p5d-pqv5p-b4q33-h283d",
  "oemDeviceId": "h51p5d-pqv5p-b4q33-h283d-h9v1j",
  "vin": "WBYF2AW010FN82675",
  "muted": false,
  "createdAt": "2024-01-15T10:30:00Z",
  "currentSeverity": "MEDIUM",
  "triggerName": "Trigger",
  "triggerDescription": null,
  "oemAlerts": [
    {
      "status": "ACTIVE",
      "oemCode": "TIRE_DEFLATING_ALERT",
      "oemMessage": null,
      "oemMetadata": {
        "hourly_tires_deflation_rate": 0.4,
        "daily_tires_deflation_rate": -1.1,
        "daily_tires_deflation_rate_recent": -1.6,
        "daily_tires_pump_up_count": 0,
        "recent_tires_pump_up_count": 0,
        "hourly_tires_pump_up_count": 0
      },
      "mappedMessage": "Tire deflating alert",
      "severity": null,
      "mappedCode": "TIRE_DEFLATING_ALERT",
      "affectedComponent": "TIRES",
      "recommendedAction": "SERVICE_REQUIRED",
      "type": "FAULT"
    }
  ],
  "resolutions": [
    {
      "id": "hpqv5p-b4q33-h283d-h9v1j-51p5d",
      "definition": {
        "id": "hb4q33-h283d-h9v1j-51p5d-pqv5p",
        "name": "Tire Pressure Check",
        "description": "Check and adjust tire pressure"
      },
      "status": "PENDING",
      "steps": [
        {
          "id": "hh283d-h9v1j-51p5d-pqv5p-b4q33",
          "status": "PENDING",
          "definition": {
            "id": "h9v1j-51p5d-pqv5p-b4q33-h283d",
            "description": "Check tire pressure",
            "order": 1
          }
        }
      ]
    }
  ],
  "definition": {
    "id": "h51p5d-pqv5p-b4q33-h283d-h9v1j",
    "name": "Tire deflating",
    "description": "A tire is losing pressure",
    "message": "Tire pressure is below the recommended level",
    "category": {
      "id": "fds95-z9cnz-8e0nz-rrqe6-sp835",
      "code": "TIRE_PRESSURE",
      "name": "Tire pressure",
      "description": "Low tire pressure or abnormal tire conditions detected"
    }
  },
  "metadata": {
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2024-01-15T10:35:00Z"
  }
}

{
  "id": "h9v1j-51p5d-pqv5p-b4q33-h283d",
  "status": "RESOLVED",
  "alertDefinitionId": "h51p5d-pqv5p-b4q33-h283d-h9v1j",
  "oemDeviceId": "hpqv5p-b4q33-h283d-h9v1j-51p5d",
  "vin": "WBYF2AW010FN82676",
  "muted": false,
  "createdAt": "2024-01-15T09:00:00Z",
  "currentSeverity": null,
  "triggerName": null,
  "triggerDescription": null,
  "oemAlerts": null,
  "resolutions": [
    {
      "id": "hb4q33-h283d-h9v1j-51p5d-pqv5p",
      "definition": {
        "id": "hh283d-h9v1j-51p5d-pqv5p-b4q33",
        "name": "Tire Pressure Check",
        "description": "Check and adjust tire pressure"
      },
      "status": "COMPLETED",
      "steps": [
        {
          "id": "h9v1j-51p5d-pqv5p-b4q33-h283d",
          "status": "COMPLETED",
          "definition": {
            "id": "h51p5d-pqv5p-b4q33-h283d-h9v1j",
            "description": "Check tire pressure",
            "order": 1
          }
        },
        {
          "id": "hpqv5p-b4q33-h283d-h9v1j-51p5d",
          "status": "COMPLETED",
          "definition": {
            "id": "hb4q33-h283d-h9v1j-51p5d-pqv5p",
            "description": "Inflate tires if needed",
            "order": 2
          }
        }
      ]
    }
  ],
  "definition": {
    "id": "hh283d-h9v1j-51p5d-pqv5p-b4q33",
    "name": "Tire deflating",
    "description": "A tire is losing pressure",
    "message": "Tire pressure is below the recommended level",
    "category": {
      "id": "fds95-z9cnz-8e0nz-rrqe6-sp835",
      "code": "TIRE_PRESSURE",
      "name": "Tire pressure",
      "description": "Low tire pressure or abnormal tire conditions detected"
    }
  },
  "metadata": {
    "createdAt": "2024-01-15T09:00:00Z",
    "updatedAt": "2024-01-15T10:20:00Z"
  }
}

{
  "id": "h51p5d-pqv5p-b4q33-h283d-h9v1j",
  "status": "ACTIVE",
  "alertDefinitionId": "hpqv5p-b4q33-h283d-h9v1j-51p5d",
  "oemDeviceId": "hb4q33-h283d-h9v1j-51p5d-pqv5p",
  "vin": "WBYF2AW010FN82677",
  "muted": true,
  "createdAt": "2024-01-15T08:00:00Z",
  "currentSeverity": "HIGH",
  "triggerName": "Trigger",
  "triggerDescription": null,
  "oemAlerts": null,
  "resolutions": [],
  "definition": {
    "id": "hh283d-h9v1j-51p5d-pqv5p-b4q33",
    "name": "Enable data sharing for BMW",
    "description": "Vehicle data sharing is not yet enabled",
    "message": "Data sharing is not enabled",
    "category": {
      "id": "cqj4a-s75z1-xbg54-jjyr0-9x1bw",
      "code": "CONNECTIVITY",
      "name": "Connectivity",
      "description": "Vehicle requires reconnection or re-authentication to resume data sharing"
    }
  },
  "metadata": {
    "createdAt": "2024-01-15T08:00:00Z",
    "updatedAt": "2024-01-15T08:05:00Z"
  }
}

7. `journey.updated`

This event is triggered when a vehicle journey is created or updated. A journey represents a trip taken by a vehicle, including start and end locations, distance traveled, energy consumption, and other metrics.

Schema

The complete JSON schema for this event is available here.

Example Payloads

{
  "id": "h283d-h9v1j-51p5d-pqv5p-b4q33",
  "vehicleId": "h9v1j-51p5d-pqv5p-b4q33-h283d",
  "distanceTravelledKm": 25.5,
  "odometerStart": 45230.0,
  "odometerEnd": 45255.5,
  "energyUsedKwh": 5.2,
  "energyStartKwh": 65.0,
  "energyEndKwh": 59.8,
  "socUsed": 8.0,
  "socStart": 85,
  "socEnd": 77,
  "startTimestamp": "2024-01-15T10:00:00Z",
  "stopTimestamp": "2024-01-15T10:35:00Z",
  "startLatitude": 37.7749,
  "startLongitude": -122.4194,
  "stopLatitude": 37.7849,
  "stopLongitude": -122.4094,
  "vin": "WBYF2AW010FN82675",
  "timestamp": "2024-01-15T10:35:00Z"
}

{
  "id": "h9v1j-51p5d-pqv5p-b4q33-h283d",
  "vehicleId": "h51p5d-pqv5p-b4q33-h283d-h9v1j",
  "distanceTravelledKm": 12.3,
  "odometerStart": 12345.0,
  "odometerEnd": 12357.3,
  "energyUsedKwh": null,
  "energyStartKwh": null,
  "energyEndKwh": null,
  "socUsed": null,
  "socStart": null,
  "socEnd": null,
  "startTimestamp": "2024-01-15T14:00:00Z",
  "stopTimestamp": "2024-01-15T14:20:00Z",
  "startLatitude": 40.7128,
  "startLongitude": -74.006,
  "stopLatitude": 40.7228,
  "stopLongitude": -74.016,
  "vin": "WBYF2AW010FN82676",
  "timestamp": "2024-01-15T14:20:00Z"
}

{
  "id": "h51p5d-pqv5p-b4q33-h283d-h9v1j",
  "vehicleId": "hpqv5p-b4q33-h283d-h9v1j-51p5d",
  "distanceTravelledKm": 45.8,
  "odometerStart": 78900.0,
  "odometerEnd": 78945.8,
  "energyUsedKwh": 8.5,
  "energyStartKwh": 50.0,
  "energyEndKwh": 41.5,
  "socUsed": 12.0,
  "socStart": 80,
  "socEnd": 68,
  "startTimestamp": "2024-01-15T16:00:00Z",
  "stopTimestamp": "2024-01-15T16:55:00Z",
  "startLatitude": 51.5074,
  "startLongitude": -0.1278,
  "stopLatitude": 51.5174,
  "stopLongitude": -0.1178,
  "vin": "WBYF2AW010FN82677",
  "timestamp": "2024-01-15T16:55:00Z"
}

{
  "id": "hpqv5p-b4q33-h283d-h9v1j-51p5d",
  "vehicleId": "hb4q33-h283d-h9v1j-51p5d-pqv5p",
  "distanceTravelledKm": null,
  "odometerStart": null,
  "odometerEnd": null,
  "energyUsedKwh": 3.2,
  "energyStartKwh": 40.0,
  "energyEndKwh": 36.8,
  "socUsed": 5.0,
  "socStart": 60,
  "socEnd": 55,
  "startTimestamp": "2024-01-15T18:00:00Z",
  "stopTimestamp": "2024-01-15T18:15:00Z",
  "startLatitude": null,
  "startLongitude": null,
  "stopLatitude": null,
  "stopLongitude": null,
  "vin": "WBYF2AW010FN82678",
  "timestamp": "2024-01-15T18:15:00Z"
}

OEM Alert Vocabulary

An OEM alert is a diagnostic message about the vehicle, such as a fault or warning reported by its manufacturer. Volteras maps each one onto a common set of values, so the same fault reads the same way across manufacturers. Any of these fields can be null, for example when an alert has no mapping. These values appear on the OEM_ALERT metric type of device.telemetry, and on each entry of oemAlerts on alert.updated.

`mappedCode`

The normalised fault code. One of 174 values:

ABS_FAULT
ACTIVE_CRUISE_CONTROL_DISABLED
ADAPTIVE_LIGHTING_FAULT
AIRBAG_SYSTEM_FAULT
AIR_FILTER_MAINTENANCE
ANTI_POLLUTION_SYSTEM_FAULT
ANTI_THEFT_ALERT
AUTOMATIC_HOLD_MALFUNCTION
AUTO_START_STOP_FAULT
AUXILIARY_BATTERY_FAULT
AUXILIARY_BATTERY_HEALTH_DEGRADED
AUXILIARY_BATTERY_LOW_VOLTAGE
AWD_DISABLED
BATTERY_CELL_FAULT
BATTERY_CELL_OVERVOLTAGE
BATTERY_CELL_UNDERVOLTAGE
BATTERY_CHARGE_FLUCTUATION
BATTERY_CHARGE_HIGH
BATTERY_CHARGE_LOW
BATTERY_CHARGING
BATTERY_DISCHARGE_RATE_HIGH
BATTERY_INSULATION_FAULT
BATTERY_MONITORING_FAILED
BATTERY_OUTPUT_RESTRICTED
BATTERY_OVERCHARGE
BATTERY_OVERHEATING
BATTERY_REGENERATION_REQUIRED
BATTERY_STORAGE_FAULT
BATTERY_TEMP_IMBALANCE
BATTERY_THERMAL_SYSTEM_FAULT
BLIND_SPOT_SYSTEM_FAULT
BONNET_OPEN
BOOT_OPEN
BRAKE_BOOSTER_FAULT
BRAKE_DISC_CORROSION_RISK
BRAKE_DRIVING_CONTROL_FAILURE
BRAKE_FLUID_DEGRADED
BRAKE_FLUID_LOW
BRAKE_LIGHT_FAULT
BRAKE_PAD_WEAR
BRAKE_SYSTEM_FAULT
CENTRAL_LOCKING_FAULT
CHARGING_ABORTED
CHARGING_COUPLER_FAULT
CHECK_ENGINE
CRASH_DETECTED
CRASH_SAFETY_MODULE
CRUISE_CONTROL_DEACTIVATED_SENSOR_ERROR
CRUISE_CONTROL_FAULT
DBC_BRAKE_ASSIST_FAILED
DC_CONVERTER_FAULT
DC_CONVERTER_OVERHEATING
DEF_LOW
DEF_QUALITY_ISSUE
DEF_SYSTEM_FAULT
DEF_WARNING
DIESEL_ENGINE_FAULT
DIESEL_IDLE_SHUTDOWN
DIESEL_PREHEAT
DOOR_OPEN
DPF_MAINTENANCE
DPF_REGENERATION_ACTIVE
DRIVERS_AIRBAG_FAULT
DRIVETRAIN_POWER_LIMITED
DSC_DEACTIVATED
DSC_FAILED
DYNAMIC_DAMPER_CONTROL_FAILED
DYNAMIC_TRACTION_CONTROL_ACTIVE
ELECTRICAL_CHARGING_FAULT
ELV_STEERING_LOCK_ACTIVE
ELV_STEERING_LOCK_FAULT
ENGINE_COOLANT_LEVEL_LOW
ENGINE_FAULT
ENGINE_INCREASED_EMISSIONS
ENGINE_OIL_LEVEL_ALERT
ENGINE_OVERHEATING
ENGINE_REDUCE_LOAD
EPS_INOPERATIVE
ESC_FAULT
EXHAUST_OVERTEMP
FOG_LIGHT_FAULT
FORWARD_COLLISION_ALERT
FORWARD_COLLISION_SYSTEM_FAULT
FUEL_CAP_ISSUE
FUEL_DOOR_OPEN
FUEL_FILTER_MAINTENANCE
FUEL_INLET_ISSUE
FUEL_LEVEL_LOW
GEARBOX_OVERHEATED
GEARBOX_OVERHEATING
GEAR_INDICATOR_FAILED
GENERAL_MALFUNCTION
HEADLIGHT_FAULT
HILL_DESCENT_FAULT
HILL_START_FAULT
HV_BATTERY_FIRE_RISK
HV_INTERLOCK_FAULT
HYBRID_SYSTEM_FAULT
IGNITION_PROBLEM
INDICATOR_LIGHT_FAULT
INTERNAL_CHARGING_EQUIPMENT_FAULT
INVERTER_FAULT
KEYLESS_ENTRY_FAULT
KEY_BATTERY_LOW
LANE_ASSIST_FAULT
LEVEL_CONTROL_SYSTEM_FAILURE
LIGHTING_SYSTEM_FAULT
LIGHT_FAULT
LOW_EXTERNAL_TEMPERATURE
LOW_SPEED_COLLISION_ALERT
LOW_SPEED_COLLISION_SYSTEM_FAULT
MOTOR_CONTROLLER_OVERHEATING
MULTIPLE_RESTRAINT_SYSTEM_FAULT
NUMBER_PLATE_LIGHT_FAULT
ODOMETER_FAILURE
OIL_LEVEL_SENSOR_MALFUNCTION
OIL_PRESSURE_LOW
PARKING_BRAKE_ACTIVE
PARKING_BRAKE_MALFUNCTION
PARKING_BRAKE_OVERHEATED
PARKING_BRAKE_RELEASE
PARKING_IMPACT_DETECTED
PARKING_LIGHTS_ON
PARK_ASSIST_FAULT
PARTICULATE_FILTER_MALFUNCTION
PASSENGER_AIRBAG_FAULT
POWERTRAIN_FAULT
POWER_STEERING_FAULT
POWER_STEERING_SERVICE_REQUIRED
PREHEATING_ACTIVE
PRESS_BRAKE_TO_START
REAR_CROSS_TRAFFIC_FAULT
REMOTE_CONTROL_KEY_FAULT
REMOTE_KEY_BATTERY_DISCHARGED
REMOTE_KEY_STATIONARY_BATTERY_LOW
RESET_CLOCK
REVERSE_LIGHT_FAULT
SEATBELT_FAULT
SEATBELT_PRETENSIONER_FAULT
SEATBELT_UNFASTENED
SECURITY_SYSTEM_FAULT
SERVICE_DUE
SERVOTRONIC_FAILED
SIDELIGHTS_ON
SIDE_AIRBAG_FAULT
SIDE_LIGHT_FAULT
STARTER_PROBLEM
SUSPENSION_FAULT
SYSTEM_CHECK_FAILED
TIRE_DEFLATING_ALERT
TIRE_PRESSURE_ALERT
TIRE_PRESSURE_MISMATCH
TIRE_PRESSURE_MONITORING_DEACTIVATED
TIRE_PRESSURE_SYSTEM_FAULT
TIRE_PUNCTURE
TRACTION_CONTROL_ACTIVE
TRACTION_CONTROL_OFF
TRACTION_MOTOR_OVERHEATING
TRAILER_BRAKE_CONNECTION_ISSUE
TRAILER_ELECTRICS_FAILED
TRAILER_LIGHT_FAULT
TRANSMISSION_FAILSAFE_ACTIVE
TRANSMISSION_MALFUNCTION
TRANSMISSION_NEUTRAL_PARKING_BRAKE
TRANSMISSION_POSITION_D_ONLY
TRANSMISSION_POSITION_N
TRANSMISSION_POSITION_P_ONLY
TRANSMISSION_RESTRICTED_POSITION
VEHICLE_SPEED_LIMIT_EXCEEDED
WASHER_FLUID_LOW
WATER_IN_FUEL
WINDSHIELD_WASHER_FLUID_LOW
WINDSHIELD_WIPER_MALFUNCTION
WRONG_REMOTE_KEY

`affectedComponent`

The part of the vehicle the alert relates to. One of 69 values:

ADAPTIVE_LIGHTING_SYSTEM
AIRBAG
AIRBAGS
AUTOMATIC_BRAKING_SYSTEM
AUTOPILOT
AUXILIARY_BATTERY
BATTERY
BODY
BRAKES
BRAKE_BOOSTER
BRAKE_FLUID
BRAKE_FRONT
BRAKE_LIGHTS
BRAKE_REAR
CAMERAS
CHARGING_COUPLER
CLOCK
COOLING
CRASH_DETECTION_SYSTEM
CRASH_SAFETY_SYSTEM
CRUISE_CONTROL
DOORS
DRIVE_TRAIN
ELECTRICAL_SYSTEM
ELECTRIC_POWER_STEERING
ELECTRONIC_STABILITY_CONTROL
EMERGENCY_BRAKING_SYSTEM
EMISSIONS_SYSTEM
ENGINE
ENGINE_OIL
EXHAUST_SYSTEM
EXTERNAL_CHARGING_EQUIPMENT
FUEL
HEADLIGHTS
HILL_START_SYSTEM
HYBRID_SYSTEM
INTERNAL_CHARGING_EQUIPMENT
KEYS
LANE_DEPARTURE_WARNING_SYSTEM
LIGHTS
LOCKS
MOTOR
NUMBER_PLATE_LIGHTS
ODOMETER
PARKING_SENSORS
PEDESTRIAN_PROTECTION_SYSTEM
REAR_LIGHTS
REVERSE_LIGHTS
ROOF
SEATBELTS
SECURITY_SYSTEM
SENSORS
SIDE_LIGHTS
SIGNAL_LIGHTS
STEERING
SUSPENSION
THERMAL_MANAGEMENT
TIRES
TIRE_PRESSURE_MONITORING_SYSTEM
TRACTION_SYSTEM
TRAILER
TRAILER_LIGHTS
TRANSMISSION
TRUNK
VEHICLE
VEHICLE_CHARGING_PORT
WASHER_LIQUID
WINDOWS
WIPERS

`recommendedAction`

What to do about the alert. One of 21 values:

CHARGE_CAR
CHECK_BATTERY_CONDITION
CHECK_BATTERY_TERMINALS
CHECK_VEHICLE_SECURE
COMPLETE_ROUTINE_MAINTENANCE
COORDINATE_RETRIEVAL
DEPRESS_BRAKE
DEPRESS_CLUTCH
DO_NOT_DRIVE
FASTEN_SEATBELTS
REFUEL
REPLACE_BULB
REPLACE_KEY_BATTERY
SERVICE_IF_ALERT_PERSISTS
SERVICE_REQUIRED
SET_CLOCK
SHUT_DOORS
SHUT_TRUNK
SWITCH_ENGINE_ON
SWITCH_IGNITION_ON
TURN_STEERING_WHEEL

`type`

The kind of alert. One of 5 values:

FAULT
INFO
ROUTINE_MAINTENANCE
TEMPORARY_FAULT
WARNING

`severity`

How severe the alert is. One of 4 values:

CRITICAL
HIGH
LOW
MEDIUM

Overview

Technical Specifications

MCP Server

Introduction

Using Webhooks

Webhook Events

1. `device.connected`

Schema

Example Payloads

2. `device.disconnected`

Schema

Example Payloads

3. `device.telemetry`

Schema

Supported Metric Types

Example Payloads

4. `command.updated`

Schema

Example Payloads

5. `rate_limit.updated`

Schema

Example Payloads

6. `alert.updated`

Schema

`oemAlerts`

Example Payloads

7. `journey.updated`

Schema

Example Payloads

OEM Alert Vocabulary

`mappedCode`

`affectedComponent`

`recommendedAction`

`type`

`severity`

​Introduction

​Using Webhooks

​Webhook Events

​1. device.connected

​Schema

​Example Payloads

​2. device.disconnected

​Schema

​Example Payloads

​3. device.telemetry

​Schema

​Supported Metric Types

​Example Payloads

​4. command.updated

​Schema

​Example Payloads

​5. rate_limit.updated

​Schema

​Example Payloads

​6. alert.updated

​Schema

​oemAlerts

​Example Payloads

​7. journey.updated

​Schema

​Example Payloads

​OEM Alert Vocabulary

​mappedCode

​affectedComponent

​recommendedAction

​type

​severity

Introduction

Using Webhooks

Webhook Events

1. `device.connected`

Schema

Example Payloads

2. `device.disconnected`

Schema

Example Payloads

3. `device.telemetry`

Schema

Supported Metric Types

Example Payloads

4. `command.updated`

Schema

Example Payloads

5. `rate_limit.updated`

Schema

Example Payloads

6. `alert.updated`

Schema

`oemAlerts`

Example Payloads

7. `journey.updated`

Schema

Example Payloads

OEM Alert Vocabulary

`mappedCode`

`affectedComponent`

`recommendedAction`

`type`

`severity`