List Of Webhook Events

Types of Events

This is a list of all the types of events we currently send. We may add more at any time, so in developing and maintaining your code, you should not assume that only these types exist.

eDRV follows the best industry practices and you will notice that these events follow a pattern: resource.event. Our goal is to design a consistent system that makes things easier to anticipate and code against.

There are four types of Webhooks sent by eDRV:

  1. Network Events Events triggered by activity on the network.
    E.g. a chargestation going offline
    Format: resource.event

  2. Actions Events that report the states of a command sent to the chargestation.
    E.g. a chargestation change configuration request
    Format: action_name.status

  3. Synchronous Events Events in response to adding / editing data on eDRV.
    E.g. adding a connector on eDRV
    Format: resource.event

  4. Charging Intelligence Events Events triggered by eDRV's charging intelligence.
    E.g. when a session's target energy value has been reached
    Format: resource.event

Network Events

These are Asynchronous events triggered by network activity, for e.g. when a driver plugs in a cable.

Chargestation Webhooks

chargestation.online data is a Chargestation
Whenever a charge station connects to eDRV

chargestation.offline data is a Chargestation
Whenever a charge station loses connection to eDRV

chargestation.connector_status.updated data is a Chargestation
Live reports of connector state directly from the chargestation.

Session Webhooks

session.updated data is a Session
Occurs whenever a session field is updated. E.g. when the chargestation reports a new energy readings via the session.metrics or the session.energy_report field.

session.started data is a Session
Occurs whenever the chargestation sends a charging start event and confirms that an energy transaction has begun.

session.ended data is a Session
Occurs whenever the chargestation confirms that an energy transaction has stopped.

session.cancelled data is a Session
Occurs whenever a session was cancelled. E.g. due to a failure to plug in the cable within time.

session.start_failure data is a Session
Occurs when chargestations was unable to start the session.

session.stop_failure data is a Session
Occurs when chargestations was unable to stop the session.

Webhooks for Actions

The format is Action.Status.
Status can be in one of three states:
requested: The request has been sent to the chargestation
completed: The chargestation accepted the request. Please see the response object for any data returned
failed: The chargestation rejected the request. See response data for any error details reported by the chargestation

session.set_power_limit.requested / completed / failed data is an Action
Occurs when reporting a set_power_limit action on a session.

session.clear_power_limit.requested / completed / failed data is an Action
Occurs when reporting a clear_power_limit action on a session.

chargestation.get_configuration.requested / completed / failed data is an Action
Occurs when fetching chargestation configurations via an API call.

chargestation.update_configuration.requested / completed / failed data is an Action
Occurs when updating a chargestation configuration via an API call.

Synchronous Events

Events that are triggered by Developer or User actions via the API or Dashboard.

organization.updated data is an Organization
Occurs whenever an organization's data is updated.

location.created data is a Location
Occurs whenever a new location is created.

location.updated data is a Location
Occurs whenever a location is updated. E.g. when business hours are changed.

location.deleted data is a Location
Occurs whenever a location is deleted.

chargestation.created data is a Chargestation
Occurs whenever a new chargestation is created.

chargestation.updated data is a Chargestation
The following fields trigger a chargestation update:

chargestation.endpoint : An update to the Websocket connection URL
chargestation.active : A change usually via an API call or the dashboard
chargestation.public : A change usually via an API call or the dashboard
chargestation.open_for_business : A change usually via an API call or the dashboard
chargestation.meta_data : Any changes to the meta_data field

chargestation.deleted data is a Chargestation
Occurs whenever a chargestation is deleted.

chargestation.connector.created data is a Chargestation
Occurs whenever a connector is created.

chargestation.connector.updated data is a Chargestation
All field changes will trigger a connector update. (Excluding status)

chargestation.connector.deleted data is a Chargestation
Occurs whenever a connector is deleted.

user.created data is a User
Occurs whenever a new user is created.

user.updated data is a User
All field changes will trigger a user update.

user.deleted data is a User
Whenever a user is deleted.

rate.created data is a Rate
Occurs whenever a new rate is created.

rate.updated data is a Rate
All field changes will trigger an update.

rate.deleted data is a Rate
Whenever a rate is deleted.

session.created data is a Session
Occurs whenever a new session has been created. eDRV is yet to receive a charging start event from the chargestation.

Charging Intelligence Events

Events that are triggered by eDRV charging intelligence. See Charging Intelligence

session.ev_charged data is a Session
Occurs when eDRV detects that an EV is fully charged.

session.target.cost.reached data is a Session
Occurs when eDRV detects that a session reached the target cost value.

session.target.time.reached data is a Session
Occurs when eDRV detects that a session reached the target time value.

session.target.energy.reached data is a Session
Occurs when eDRV detects that a session reached the target energy value.