Alexa.EndpointHealth Interface

The Alexa.EndpointHealth interface defines a series of state properties representing information about the overall health of a smart device.

This interface enables in-depth reporting of the state of devices, which are reported to the customer through experiences like the Alexa app. For example, the app could show a green, yellow or red status for a device depending on the state of its EndpointHealth properties.

StateReport

If your endpoint supports a property as retrievable, then you should report its value when you receive a ReportState directive from Alexa.

If the endpoint is currently unreachable but you can report all endpoint property values because they are cached, then return the StateReport and include all of the property values. However, specify the value of the connectivity property of EndpointHealth as UNREACHABLE. If you cannot report the state of all the properties because the endpoint is unreachable and you have not cached the values, you should send an ErrorResponse of type BRIDGE_UNREACHABLE or ENDPOINT_UNREACHABLE.