Telematica 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.
action
Whether the command was to start or stop the charging
chargerId
Charger ID of the charger in Telematica database.
code
Success or failure code for handling event
jobId
Telematica command job ID.
message
Human readable message describing the outcome
success
Boolean to denote if the command execution was successful and confirmed.
type
Name of the event
{
"action": "charger-start",
"chargerId": "64253244f8057090fb3a822b",
"code": "RESULT_CONFIRMED",
"jobId": "charger-start.charge-64253244f8057090fb3a822b",
"message": "Charger command executed and result confirmed",
"success": true,
"type": "charger.charging-command"
}devices
List of devices connected
type
Name of event
user
User-id in your database. This will be used to map devices to the user in your database.
vehicles
For backwards compatibility, will be removed soon.
{
"devices": [
{
"clientUserId": "user-id-in-your-database",
"country": "US",
"deviceId": "642f07d280dead60533b57c2",
"deviceType": "vehicle",
"engineType": "ELECTRIC",
"make": "Tesla",
"model": "Model Y",
"nickname": "My Model Y",
"vin": "7SAWDDEQXPS685253",
"year": 2020
}
],
"type": "user.devices-connected",
"user": "user-id-in-your-database"
}devices
type
user
{
"devices": [
"642f07d280dead60533b57c2"
],
"type": "user.devices-disconnected",
"user": "user-id-in-your-database"
}action
Whether the command was to start or stop the charging
code
Success or failure code for handling event
jobId
Telematica command job ID.
message
Human readable message describing the outcome
success
Boolean to denote if the command execution was successful and confirmed.
type
Name of the event
vehicleId
Vehicle ID of the vehicle in Telematica database.
{
"action": "charge-start",
"code": "RESULT_CONFIRMED",
"jobId": "charge-start.charge-64253244f8057090fb3a822b",
"message": "Charging command executed and result confirmed",
"success": true,
"type": "vehicle.charging-command",
"vehicleId": "64253244f8057090fb3a822b"
}currentState
Latest fetched charging state of the vehicle.
jobId
Telematica webhook job ID.
message
Human readable message describing the event
type
Name of the event
vehicleId
Vehicle ID of the vehicle in Telematica database.
vehicleState
Find the schema here : https://docs.telematica.so/reference/vehicledatav3controller_getprefetcheddata
7 Items
{
"currentState": "Charging",
"jobId": "641aeef260d202219c22aa3a",
"message": "Charging-status change detected",
"type": "vehicle.charging-status",
"vehicleId": "641aeef260d202219c22f03b",
"vehicleState": {
"batteryState": {
"chargeThresholdMet": true,
"isCharging": true,
"isPlugged": true,
"lastUpdated": "2023-06-29T11:29:11.815Z",
"range": 216,
"rangeUnit": "km",
"soc": 77
},
"id": "63ed07f8d2100cc452f57e3d",
"location": {
"lastUpdated": "2023-06-29T11:29:11.815Z",
"latitude": 12.345678,
"longitude": 7.3321
},
"odo": {
"lastUpdated": "2023-06-29T11:29:11.815Z",
"unit": "km",
"value": 12345
},
"state": "ACTIVE",
"stateDescription": "The connection to vehicle is active and the data is up to date.",
"staticAttributes": {
"country": "ES",
"make": "BMW",
"model": "X2 xDrive25e",
"nickname": "My BMW X2",
"registration": "GJ01M20191",
"vin": "MAT534006MPTS4325",
"year": 2022
}
}
}currentState
Latest fetched plug state of the vehicle
jobId
Telematica webhook job ID.
message
Human readable message describing the event
type
Name of the event
vehicleId
Vehicle ID of the vehicle in Telematica database.
vehicleState
Find the schema here : https://docs.telematica.so/reference/vehicledatav3controller_getprefetcheddata
7 Items
{
"currentState": "Plugged",
"jobId": "641aeef260d202219c22aa3a",
"message": "Plug-status change detected",
"type": "vehicle.plug-status",
"vehicleId": "641aeef260d202219c22f03b",
"vehicleState": {
"batteryState": {
"chargeThresholdMet": true,
"isCharging": true,
"isPlugged": true,
"lastUpdated": "2023-06-29T11:29:11.815Z",
"range": 216,
"rangeUnit": "km",
"soc": 77
},
"id": "63ed07f8d2100cc452f57e3d",
"location": {
"lastUpdated": "2023-06-29T11:29:11.815Z",
"latitude": 12.345678,
"longitude": 7.3321
},
"odo": {
"lastUpdated": "2023-06-29T11:29:11.815Z",
"unit": "km",
"value": 12345
},
"state": "ACTIVE",
"stateDescription": "The connection to vehicle is active and the data is up to date.",
"staticAttributes": {
"country": "ES",
"make": "BMW",
"model": "X2 xDrive25e",
"nickname": "My BMW X2",
"registration": "GJ01M20191",
"vin": "MAT534006MPTS4325",
"year": 2022
}
}
}currentSoc
Latest fetched SOC of the vehicle.
jobId
Telematica webhook job ID.
message
Human readable message describing the event
targetSoc
Configured target SOC for the job, at which the webhook was triggered.
type
Name of the event
vehicleId
Vehicle ID of the vehicle in Telematica database.
vehicleState
Find the schema here : https://docs.telematica.so/reference/vehicledatav3controller_getprefetcheddata
7 Items
{
"currentSoc": 40.2,
"jobId": "641aeef260d202219c22aa3a",
"message": "Target SOC reached",
"targetSoc": 40,
"type": "vehicle.soc",
"vehicleId": "641aeef260d202219c22f03b",
"vehicleState": {
"batteryState": {
"chargeThresholdMet": true,
"isCharging": true,
"isPlugged": true,
"lastUpdated": "2023-06-29T11:29:11.815Z",
"range": 216,
"rangeUnit": "km",
"soc": 77
},
"id": "63ed07f8d2100cc452f57e3d",
"location": {
"lastUpdated": "2023-06-29T11:29:11.815Z",
"latitude": 12.345678,
"longitude": 7.3321
},
"odo": {
"lastUpdated": "2023-06-29T11:29:11.815Z",
"unit": "km",
"value": 12345
},
"state": "ACTIVE",
"stateDescription": "The connection to vehicle is active and the data is up to date.",
"staticAttributes": {
"country": "ES",
"make": "BMW",
"model": "X2 xDrive25e",
"nickname": "My BMW X2",
"registration": "GJ01M20191",
"vin": "MAT534006MPTS4325",
"year": 2022
}
}
}