Skip to main content
POST
/
entities
/
asset
/
{asset_id}
/
event
Asset Event
curl --request POST \
  --url https://api-sandbox.axle.energy/entities/asset/{asset_id}/event \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "event_type": "plug_in",
  "intent": {
    "energy_required_kwh": 123,
    "ready_by": "2023-11-07T05:31:56Z",
    "energy_estimated": true,
    "may_charge_peak": false
  },
  "vehicle": {
    "charging_rate_kw": 123
  },
  "tariff": {
    "off_peak_times": "<string>",
    "timezone": "<string>"
  },
  "end_at": "2023-11-07T05:31:56Z"
}'
"<any>"

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
asset_id
string<uuid>
required

Body

application/json
​
event_type
enum<string>
required

An enumeration.

Available options:
plug_in,
plug_out,
intent_update,
charge_now,
charge_now_deleted
​
intent
object

Intent to charge the vehicle. This should only be included for "plug_in" and "intent_update" events

​
vehicle
object

Vehicle information. This should only be included for "plug_in" and "intent_update" events

​
tariff
object

Tariff information. This should only be included for "plug_in" and "intent_update" events

​
end_at
string<date-time>

End time for the charge. This should only be included for "charge_now" events

Response

Event successfully processed

The response is of type any.

⌘I