User eligibility events

Users become eligible if they are a potential target for Energy Coordination’s price curve events. This depends on if a users locations are within an area where our analysis of the electrical grid shows that there is a continued need to shift energy usage to more favorable hours.

You can keep updated on eligible users by subscribing to the UserEligibility-event. You can then enroll these users to the Energy Coordination API to receive price curve events.

How it works

The UserEligibility-event is only sent if there are changes to the eligibility of users. This can happen if a user moves to a new location, or if our analysis of the electrical grid changes. This will also happen as we introduce new areas and new use cases.

Step 1: Add your users and locations

To be notified of UserEligibility-events, you must first add your users and locations to the Energy Coordination API. You can read more about this in the adding resources guide. We recommend adding all users and locations that you have access to, as we are cooperating with several DSOs, and will add new regions and use cases continually.

Step 2: Receive events

When eligibility changes, the Energy Coordination API will send a UserEligibility-event to the partner that has registerd the user. We batch up these events, so one event might contain several new users that are eligible. There are no reports related to this event, but you can use the event to know when to enroll the users to the Energy Coordination API.

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

UserEligibility payload format

The UserEligibility-payload has the following properties:

lastUpdated: The UTC-timestamp for when the user eligibility was last updated.
addedUsers: An array of user ids that have been added as eligible.
removedUsers: An array of user ids that have been removed as eligible.
payloadType: The type of the payload. For this payload it is always set to UserEligibility to identify that this is a UserEligibility-event.

Example event

This is an example payload of a typical UserEligibility-event:

{
  "id": "d6774a68-8906-4af4-aba2-e1a1042545b6",
  "createdAt": "2024-09-25T18:38:36.9991566+00:00",
  "payload": {
    "lastUpdated": "2024-09-24T18:38:36.999158+00:00",
    "addedUsers": [
      "6e4b4ca7-310b-4c65-a88a-064a2e2e987f"
    ],
    "removedUsers": [
      "a543f528-a40c-456f-862b-14b8f9d48f99"
    ],
    "payloadType": "UserEligibility"
  }
}