Webhooks
About
In general the Partner API is polling-based, so you have to call our endpoints in order to get information. However, for selected partners, we added support for webhooks. Here you can provide a secret and endpoint and our system will inform you whenever a relevant (and supported) entity has changed.
How To
To get started you need to configure webhooks for your API consumer. There are 3 relevant parts to it:
/webhooks/config- to set your secret and webhook endpoint we should call (read more)- Our system will call your endpoint periodically (e.g. every 2 seconds) with a list of pending events
- Additionally you can check out the /webhooks/entries endpoint to retrieve all pending or failed events of the past 24 hours - useful to debug any issues (we provide
state(pending,failed) as well as anerrorpayload for you).
Overview
⛔️ No Guarantee of Order and Delivery
Similar to many other webhook implementations (Google, Stripe, etc.) there is no guarantee that every change is tracked or every event is successfully delivered to your system. Therefore make sure to implement a reconciliation strategy for entities that are critical to your operations (i.e. daily sync of charges using the respective endpoints).
The same is true for the order of events.
Supported Event Types
Currently we support webhooks for these event types:
| Name | Type | Description |
|---|---|---|
| Charge Transactions | charges | An event is triggered when either kwh, state or soc were updated. |
| Charge Auth Tokens | charge-auth-tokens | Any change to this entity will trigger an event. |
| Charge Points | charge-points | Any change (except kWh changes) to this entity will trigger an event. You can monitor kWh changes either on state change or charge webhooks. |
| Sites | sites | Any change to this entity will trigger an event. |
| Teams | teams | Any change to this entity will trigger an event. |
| Team Members | team-members | Any change to this entity will trigger an event. |
| Installer Jobs | installer-jobs | Any change to this entity will trigger an event. |
| Wallet Transactions | wallet-transactions | Any change to this entity will trigger an event. |
| Price Groups | price-groups | Any change to this entity will trigger an event. |
| Plans | plans | Any change to this entity will trigger an event. |
| Reports | reports | Any change to this entity will trigger an event. |
| Subscriptions | subscriptions | Any change to this entity will trigger an event. |
| Users | users | Any change to this entity will trigger an event. |
A creation or deletion will always trigger an event for any of the above event types.
Technical Integration
Updated 26 days ago