Skip to main content

Webhook Notifications

To keep the Core (NestJS) synchronized with real-time hardware events, we use a Webhooks system (HTTP POST).

Required Header for Security: X-API-Key: <SERVER_API_KEY>

Supported Events​

1. Critical Fault (CHARGER_FAULT)​

Triggered when a connector enters a faulted state (Faulted).

{
  "event": "CHARGER_FAULT",
  "charger_id": "EVSE-001",
  "data": {
    "connector_id": "1",
    "status": "Faulted",
    "error_code": "GroundFailure"
  },
  "ts": "2026-03-16T14:30:00Z"
}

2. Transaction Start (TRANSACTION_STARTED)​

Triggered when a session is authorized and started.

{
  "event": "TRANSACTION_STARTED",
  "charger_id": "EVSE-001",
  "transaction_id": "1710594800",
  "data": {
    "connector_id": "1",
    "id_tag": "UID_12345",
    "timestamp": "2026-03-16T14:30:00Z",
    "meterStart": 1500.5
  },
  "ts": "2026-03-16T14:30:00Z"
}

3. Transaction End (TRANSACTION_ENDED)​

Triggered when the session is ended at the hardware.

{
  "event": "TRANSACTION_ENDED",
  "charger_id": "EVSE-001",
  "transaction_id": "1710594800",
  "data": {
    "connector_id": "1",
    "id_tag": "UID_12345",
    "timestamp": "2026-03-16T15:45:00Z",
    "meterStop": 2500.0
  },
  "ts": "2026-03-16T15:45:00Z"
}

4. Real-time Consumption (METER_VALUE)​

Triggered periodically during an active recharge.

{
  "event": "METER_VALUE",
  "charger_id": "EVSE-001",
  "transaction_id": "1710594800",
  "data": {
    "connector_id": "1",
    "currentEnergyWh": 2100.2
  },
  "ts": "2026-03-16T15:00:00Z"
}