events

Get stream of events for all appliances - NOT WORKING WITH SWAGGER

Server Sent Events are available as Eventsource API in JavaScript and are implemented by various HTTP client libraries and tools including curl.

Unfortunately, SSE is not compatible to OpenAPI specs and can therefore not be properly specified within this API description.

An SSE event contains three parts separated by linebreaks: event, data and id. Different events are separated by empty lines.

The event field can be one of these types: KEEP-ALIVE, STATUS, EVENT, NOTIFY, CONNECTED, DISCONNECTED, PAIRED, DEPAIRED.

In case of all event types (except KEEP-ALIVE), the "data" field is populated with the JSON object defined below.

The id contains the home appliance ID. (except for KEEP-ALIVE event type)

Further documentation can be found here:

get/homeappliances/events

Request

  • Base URL: https://api.home-connect.com/api
  • URL: https://api.home-connect.com/api/homeappliances/events
  • Auth: OAuth 2 (authorization code, authorization URL https://api.home-connect.com/security/oauth/authorize, token URL https://api.home-connect.com/security/oauth/token, scopes: Monitor, Oven-Monitor, Dishwasher-Monitor, Washer-Monitor, Dryer-Monitor, FridgeFreezer-Monitor, CoffeeMaker-Monitor, Hob-Monitor, Hood-Monitor, CleaningRobot-Monitor, WasherDryer-Monitor, Refrigerator-Monitor, Freezer-Monitor, WineCooler-Monitor, CookProcessor-Monitor, Oven, Dishwasher, Washer, Dryer, FridgeFreezer, CoffeeMaker, Hob, Hood, CleaningRobot, WasherDryer, Refrigerator, Freezer, WineCooler, CookProcessor)

Response

Returns status updates as Server Sent Events (SSE)

Changes

No recorded changes to this operation across all 1 revision of this API.