Webhooks
Events
Event Based Webooks allow your application to listen for events as they happen to a vehicle placing less reliance on the need to poll for state changes.
eventType | Permission | Description |
---|---|---|
CHARGING_STARTED | read_charge_events | Fired when a vehicle starts charging. |
CHARGING_STOPPED | read_charge_events | Fired when a vehicle prematurely stops charging. |
CHARGING_COMPLETE | read_charge_events | Fired when a vehicle succesfully reaches it’s charging limit. |
{
"version": "2.0",
"webhookId": "abde94ff-d57d-43b9-8d09-6020db2d977a",
"eventName": "eventBased",
"mode": "live",
"payload": {
"eventId": "1713eab1-eebc-4b4e-9433-0f2a488851c2",
"vehicleId": "9af13248-3b73-4c9d-9a4b-d937ce6bc8e2",
"eventType": "CHARGING_STARTED",
"eventTime": "2022-04-06T01:4 8:22.845Z"
}
}
{
"version": "2.0",
"webhookId": "abde94ff-d57d-43b9-8d09-6020db2d977a",
"eventName": "eventBased",
"mode": "live",
"payload": {
"eventId": "1713eab1-eebc-4b4e-9433-0f2a488851c2",
"vehicleId": "9af13248-3b73-4c9d-9a4b-d937ce6bc8e2",
"eventType": "CHARGING_STARTED",
"eventTime": "2022-04-06T01:4 8:22.845Z"
}
}