https://api-sandbox.axle.energy. You’ll onboard a battery, send telemetry for it, then
have us send dispatch and opt-out webhooks to your endpoint.
Sandbox and production are kept fully apart. Identifiers, tokens and webhook signing keys from one
won’t work in the other.
Requirements
Before you start, get in touch and we’ll set you up with:
Once you have your credentials, exchange them for a token:
access_token from the response and export it as AXLE_TOKEN for the requests below.
Tokens expire after an hour, so request a new one when you get a 401. See
Authentication for the full reference.
Run through
1
Onboard a battery
You need a sandbox Keep the
site_id and asset_id before you can send telemetry or receive dispatch.
Use whichever onboarding pathway you’re building.- Through your app
- Through Axle's signup flow
Register a site and battery with
The response carries the identifiers for the new site and asset:
POST /entities/site/onboard-site-and-asset:asset_id. You’ll use it in the next two steps.2
Send telemetry
Push readings for the battery to We reply with a result for each reading:A rejected reading comes back with
POST /data/readings. For an
event-only battery the minimum is state of charge and boundary power, both instantaneous, so
start_timestamp and end_timestamp match:"accepted": false and the reason in error. Once single
requests are accepted, leave it running on the 5-minute cadence
you’ll use in production.3
Receive events
Call We reply once the event is queued, and delivery follows within a few seconds. The event that
lands at your endpoint asks for a 1-hour discharge starting an hour from now:Check that your endpoint:If we refuse a test send, the reason is in
POST /webhooks/test and we’ll deliver a dummy event to the endpoint you’ve registered,
through the same signing and retry machinery as a real one. Set overrides.asset_id to your
sandbox battery so the test drives your handler all the way through:- Verifies the signature with your signing key.
- Returns a
2xxonce it has durably accepted the event. - Applies the target power to the battery, or recognises
"test": trueand skips it if you’d rather not move real hardware.
"event_type": "vpp:site:opted_out" to check your opt-out handling.Unlike a real dispatch, a test window isn’t aligned to a 30-minute boundary and its timestamps
carry microseconds.
detail. See
When we refuse a test send.Next steps
Integration
The full integration contract for onboarding, telemetry, dispatch and opt-outs
Webhooks
Envelope, signature verification, responses and retries

