Fleet API Webhook
Overview
The Fleet API Webhook allows customers to receive real-time vehicle data at their desired endpoint. If you are new to the Fleet API Webhook, please refer to the Fleet API Webhook Overview document first.
Supported Webhook Events
| Webhook Event Type | Description |
|---|---|
| Periodic Data (Periodic data) | Provides a snapshot of vehicle data periodically generated by the vehicle |
| Vehicle Event Data (Vehicle event) | Provides event details when events such as door opening occur in the vehicle |
For detailed schemas of the supported webhook event types, please refer to each document.
ValueObject
Vehicle data is structured as ValueObject<T>, and the schema of ValueObject is as follows.
Schema
| Key Name | Description | Value Type | Sample Value |
|---|---|---|---|
| value | The value held by ValueObject | T | 123 |
| eventTime | The time the value occurred (ISO 8601) | String | 2025-02-12T08:12:58.628000000Z |
Example
ValueObject<Double> (e.g. Speed)
{
"value": 33.0,
"eventTime": "2025-02-12T08:12:58.628000000Z"
}
ValueObject<String> (e.g. Charging status)
{
"value": "ACTIVE",
"eventTime": "2025-02-12T08:12:58.628000000Z"
}