Skip to content

Notifications

Endpoints for communicating notifications.

Operations

List notifications

Request

Lists notifications for the user making the request. For each notification it returns a category (INFO, ERROR etc) and a title (in the user's language) for display in their inbox.

Security
oauth2
Query
page_beforestring[a-z]{4}[A-Z\d]{26}

Return results from the page after this ID.

Example:page_before=xmpl01HNFZM7Q8FXASZXYZ6XM3TQRR
page_afterstring[a-z]{4}[A-Z\d]{26}

Return results from the page before this ID.

Example:page_after=xmpl01HNFZM7Q8FXASZXYZ6XM3TQRR
page_sizeinteger, [ 1 .. 100 ]

Specify the number of results to return per page.

Default:25
Example:page_size=10
Headers
EvEnergy-Versionnumber

Specify the version of this endpoint to use.

Value:2
Accept-Languagestring

Indicates the natural language and locale that the client prefers.

EvEnergy-Userstringuser[A-Z\d]{26}

If the client is authenticated using Client Credentials, setting EvEnergy-User to a valid user ID allows requests to be made as if you were directly authenticated as that user.

Example:user01HN2NJ9NMRZBXT1H6FT9N7735
curl -i -X GET \
  'https://developers.ev.energy/_mock/ev.energy-api-v2/notifications?page_before=xmpl01HNFZM7Q8FXASZXYZ6XM3TQRR&page_after=xmpl01HNFZM7Q8FXASZXYZ6XM3TQRR&page_size=10' \
  -H 'Accept-Language: string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'EvEnergy-User: user01HN2NJ9NMRZBXT1H6FT9N7735' \
  -H 'EvEnergy-Version: 2'

Responses

Retrieve all current notifications.

Headers
EvEnergy-Versionnumber

Indicates the version of the API that generated this response. If EvEnergy-Version was not specified in the request, this will be your OAuth application's default version.

Value:2
X-RateLimit-Limitnumber

The maximum number of requests that can be made to this endpoint per hour. Defaults to 1000 but may vary per client.

Default:1000
X-RateLimit-Remainingnumber

The number of requests remaining until this client's rate limit is reached.

Default:999
RetryAfternumber

The number of seconds until this client's requests will not be rate limited.

Default:3600
Bodyapplication/json
Array [
idstringnotf[A-Z\d]{26}required

Unique identifier for the Notification

Example:"notf67O36PLTFDB57M0E5L33JZLGM0"
urlstring, (uri)required
Example:"https://api.ev.energy/notifications/notf67O36PLTFDB57M0E5L33JZLGM0"
message_idstringrequired

Internal identifier for this notification type. E.g. 'ERR0023'

categoryanyrequired

Category of this notification type

Enum:"ACTIONABLE""SERVICE""RETRY""MARKETING""INTERNAL"
event_timestring, (date-time)required

The timestamp of the event described by this notification

short_text_titlestring, <= 33 charactersrequired

Short title for the notification

short_text_bodystring, <= 49 charactersrequired

Short description of the event being notified

detail_page_titlestringrequired

Title of a help page giving more information about this notification

detail_page_bodystringrequired

Text of a help page giving more information about this notification

external_button_labelstringrequired

Text to be displayed on a button leading to the external_link location

read_atstring, (date-time)

When the user examined the contents of this notification

resolved_atstring, (date-time)

When the problem associated with this notification was resolved

]
Response
[
  {
    "id": "notf67O36PLTFDB57M0E5L33JZLGM0",
    "url": "https://api.ev.energy/notifications/notf67O36PLTFDB57M0E5L33JZLGM0",
    "message_id": "ERR0123",
    "category": "ACTIONABLE",
    "event_time": "2019-08-24T14:15:22Z",
    "short_text_title": "Your car is disconnected",
    "short_text_body": "We need to reconnect to keep smart charging",
    "detail_page_title": "Your car is disconnected",
    "detail_page_body": "Your car has been disconnected. This happens when your password is reset.\nWe need you to re-authorise ev.energy to access your account in order for us to keep managing your charging.\nBlah blah blah.",
    "external_link": "https://example.com",
    "external_button_label": "More info"
  }
]