Webhooks
No OAuth-enabled endpoints in this section. Turn off the OAuth filter in the sidebar to see all of its endpoints.
Session updated
Fired whenever a charging session changes state or its energy/cost figures change. In practice you will see one event per state transition and one event when a settlement correction lands. Treat each event as a snapshot of the session, not a delta: events are delivered at-least-once and are not strictly ordered, so deduplicate on the envelope id and use the envelope time to detect stale events.
Header parameters4
Identifier of the delivery in our system. Stable across retries of the same event. Useful for support requests, but not protected by the signature; deduplicate on the envelope id instead.
The event type. Matches the type field in the body.
Unix seconds the signature was produced. Used to bound the signature window and prevent replay; reject deliveries older than a sensible window (we recommend 5 minutes).
Hex-encoded HMAC-SHA256 of "<Webhook-Timestamp>.<raw-body>" keyed by your whsec_ signing secret. Verify against the raw request body bytes before parsing, using a constant-time comparison.
Request bodyREQUIREDapplication/json
dataobjectREQUIREDThe event-specific payload. Mirrors the public Session shape returned by GET /sessions/{sessionId}
The event-specific payload. Mirrors the public Session shape returned by GET /sessions/{sessionId}
Optional external reference or identifier provided when starting the session
Total energy consumed during the session in kilowatt-hours
Cost of the session so far in the specified currency, excluding VAT. May be absent until the network reports it
ISO 4217 currency code for the cost
Number of times this session has been settled. 1 on first settlement, increments on each correction. Absent for unsettled sessions.
Timestamp when the charging session actually started
Timestamp when the charging session was stopped
Unique identifier of the charging session
Unique identifier of the charge point where the session is taking place
State of the charging session after this update
RFC 3339 timestamp of when the event was produced. Use this to compare ordering between events for the same resource
CloudEvents spec version this envelope conforms to. Always 1.0
Unique identifier of the logical event. Stable across all retries of the same event; use this for deduplication. It is the only id protected by the signature
The event type. Matches the Webhook-Event header
session.updatedOrigin of the event. Always charge-now/api
Media type of the data field. Always application/json