What are events?

Events are used in the Energy Coordination API to inform you as a DER-partner of things that have happened. One example here is that we have forecasted an issue with the power grid which requires shifting energy usage within an area. Other events are simply informational or operational in nature. The endpoint /events will list all events that are available to you.

Events are unique for each partner, and some may require a change or reaction from the partner-systems. The API must be notified of these changes by sending a report to the Energy Coordination API.

Important

While it is possible to fetch events from the /events endpoint, it is not recommended to poll this endpoint continually for new events. Instead, we recommend you use webhooks to receive real-time notifications when new events are available. The main use case for the /events endpoint is to provide a way to fetch events that you may have missed due to downtime or other issues.

Event format

The event is available as a JSON object with the following properties:

• id: The id of the event that the report corresponds to.
• createdAt: The UTC-timestamp for when the event happened
• payload: The payload of the event

Each event is unique to you as a partner and will only contain information relevant to your resources and locations.

Event Payload Types

Regardless of the type of event, the payload will always contain the payloadType property. This property is used to determine the type of the payload, and to a specific value in order for the integration partner to understand how they should parse the payload.

The Energy Coordination API currently supports the following event payloadTypes:

• PriceCurve: Sent when a new price curve is created. See the price curve event guide for more information.
• UserEligibility: Sent when the eligibility of your users is updated. See the user eligibility event guide for more information.
• LocationLPC: Sent when a new location-based limitation of power consumption is requested. See the location LPC event guide for more information.

Important

The LocationLPC-event is only sent to specific partners on an invite-only basis, and the structure of this event is subject to change.

More event types will be added as the API evolves.

Simulating events

You can simulate events in the Sandbox-environment to be able to test your integration. How to do this is described in the Simulating Events guide.