Works with Alexa Certification Requirements
Products eligible for Works with Alexa (WWA) certification must adhere to stringent requirements. Review the following requirements before you submit your product for certification.
For general guidelines about the Works with Alexa program and how to submit your devices for testing, see Works with Alexa Overview.
- Mobile app requirements
- Device requirements
- Alexa skill requirements
- Badge requirements
- Related topics
Mobile app requirements
If your device has a mobile app for setup and account linking, your app must support both iOS and Android.
Device requirements
Your device must implement the capability interfaces for the features your product supports. To be eligible for certification, your device must support the required interfaces specified for your device. Some device types have no required capability interfaces. All devices must support device discovery and state reporting. For details, see Alexa.Discovery and Understand State Reporting.
Climate control
The following table shows the required capability interfaces for devices in the climate control category.
Example devices | Required Functionality | Required Alexa capability interfaces |
---|---|---|
Air conditioner | Set temperature, query current temperature | ThermostatController |
Air filter | Turn on power, turn off power | PowerController |
Air purifier | Turn on power, turn off power | PowerController |
Fan | Turn on power, turn off power | PowerController |
HVAC unit | Set temperature, query current temperature | ThermostatController |
Thermostat | Set temperature, query current temperature | ThermostatController |
If your product supports any of the following optional climate control features, specify the capabilities when you register your product:
Entertainment
The following table shows the required capability interfaces for devices in the entertainment category.
Example devices | Required Functionality | Required Alexa capability interfaces |
---|---|---|
Amplifier | Set and adjust volume, mute, unmute, select input | Speaker, InputController |
Projector | Turn on power, turn off power | PowerController |
Receiver | Set and adjust volume, mute, unmute, select input | Speaker, InputController |
Remote control | Set channel, set and adjust volume, mute, unmute, turn on power, turn off power | ChannelController, InputController, PowerController |
Sound bar | Play device, stop device, pause device, set and adjust volume, mute, unmute | PlaybackController, Speaker |
Speaker | Play device, stop device, pause device, set and adjust volume, mute, unmute | PlaybackController, Speaker |
Subwoofer | Set equalizer bands, set sound modes | EqualizerController |
Television | Set channel, set and adjust volume, mute, unmute, turn on power, turn off power | ChannelController, InputController, PowerController |
If your product supports any of the following optional entertainment features, specify the capabilities when you register your product:
Home office
The following table shows the required capability interfaces for devices in the home office category.
Example devices | Required Functionality | Required Alexa capability interfaces |
---|---|---|
Router | Enable network access, disable network access | NetworkAccessController |
If your product supports any of the following optional home office features, specify the capabilities when you register your product:
Home security
The following table shows the required capability interfaces for devices in the home security category.
Example devices | Required Functionality | Required Alexa capability interfaces |
---|---|---|
Camera | Retrieve camera stream | CameraStreamController |
Doorbell | Capture doorbell events | DoorbellEventSource |
Door lock | Set lock, unlock | LockController |
Garage door opener | Open garage door, close garage door | ModeController with semantics |
Security panel | Arm security system, disarm security system | SecurityPanelController |
If your product supports any of the following optional security features, specify the capabilities when you register your product:
Household and personal care
The following table shows the required capability interfaces for devices in the household and personal care category.
Example devices | Required Functionality | Required Alexa capability interfaces |
---|---|---|
Aroma diffuser | Turn on power, turn off power | PowerController |
Vacuum | Turn on power, turn off power, return to charging base, |
PowerController, Implement return to base with PowerController TurnOff directive or ModeController with semantics |
Kitchen and cooking appliances
The following table shows the required capability interfaces for devices in the kitchen and cooking appliances category.
Example devices | Required Functionality | Required Alexa capability interfaces |
---|---|---|
Microwave | Start and stop cooking, change cooking mode, cook by time, pause cooking, resume cooking | Cooking.TimeController, TimeHoldController |
Lighting and power
The following table shows the required capability interfaces for devices in the lighting and power category.
Example devices | Required Functionality | Required Alexa capability interfaces |
---|---|---|
Dimmer | Turn on power, turn off power | PowerController |
Lamp | Turn on power, turn off power | PowerController |
Light bulb | Turn on power, turn off power | PowerController |
Light strip | Turn on power, turn off power | PowerController |
Power strip | Turn on power, turn off power | PowerController |
Plug | Turn on power, turn off power | PowerController |
Switch | Turn on power, turn off power | PowerController |
If your product supports any of the following optional features, specify the capabilities when you register your product:
Sensors
The following table shows the required capability interfaces for devices in the sensors category.
Example devices | Required Functionality | Required Alexa capability interfaces |
---|---|---|
Contact sensor | Detect and report contact | ContactSensor |
Motion sensor | Detect and report motion | MotionSensor |
Alexa skill requirements
If your product connects to Alexa through a skill, your skill must meet the following requirements before you submit your product for WWA certification.
- Use the smart home model and include code in a Lambda function to provide communication between Alexa and your product. For details, see Understand the Smart Home Skill API and Steps to Build a Smart Home Skill.
- Target version 3 of the Smart Home API. In device discovery, describe the payload version as 3, and specify each capability listed as version 3. For details, see Alexa.Discovery.
- Implement the required capability interfaces.
- Follow the state reporting requirements.
- Implement EndpointHealth.
- Support account linking. For details, see Understand Account Linking.
- Support proactive management. For details, see How to Proactively Manage Endpoints.
- Receive skill certification and publish in the Alexa skill store. For details, see Smart Home Skill Publishing Guide.
Required capability interfaces
Your skill must implement the capability interfaces for the features your product supports. To be eligible for certification, your skill must use the required interfaces specified for your device. Some device types have no required capability interfaces. Return all supported capabilities in the discovery response. For details about the required capabilities, see Device requirements.
State reporting requirements
State reporting enables the Alexa app to accurately reflect the status of smart home devices. For general information about state reporting, see Understand State and Change Reporting and Send Events to the Event Gateway.
Your skill must implement state reporting as follows:
- Mark all capability properties as
retrievable
andproactivelyReported
in your discovery response. For details, see Alexa.Discovery. - Always report the state of all capability properties in the context of an
Alexa.Response
event when you respond to a control directive, including properties defined byEndpointHealth
. For details, see Report state in an Alexa.Response. - Respond to
ReportState
directives withStateReport
events. For details, see Report State in a StateReport. - Send
ChangeReport
events when the device state changes for any reason. For details, see Report State in a ChangeReport. - When the state of a reported property changes, you must send a
ChangeReport
with the new property value within three seconds of the state change. TheChangeReport
must also include the current value of theconnectivity
property, defined by the Alexa.EndpointHealth interface. - If the
connectivity
of the device changes toOK
, send the report in three seconds or less. - If a
ChangeReport
event fails with HTTP errors 503, 429, or 401, or the message times out, try to resend theChangeReport
. When you resend, do so at least two more times with a delay of no more than 15-second intervals between each try. For details, see the error section of the Send Events to the Alexa Event Gateway.
Test state reporting
Enable your skill for testing in the development portal and test it thoroughly with your device and an Alexa-enabled device or app. Your skill must respond quickly and handle error conditions correctly to make it through the WWA certification process. For details, see Debug Your Smart Home Skill.
Badge requirements
WWA badges are for products intended to be sold on Amazon.com. Before you request the WWA badge, apply the relevant updates and fixes found during the WWA certification process to your product.
To receive a WWA badge, your product must meet the following requirements:
- Your product has an ASIN.
- The ASIN must be available on Amazon.com, in the country requested, and can't be unavailable, invalid, or suppressed.
- The model number for the ASIN must match the product model number listed on the ASIN detail page.
- If your product connects to Alexa with a hub, the hub ASIN must be the same as the hub tested during WWA certification.
- If your product has an Alexa skill, the skill must be available on Amazon.com, in the country requested, and cannot be unavailable, invalid, or suppressed.
If your product doesn't meet these requirements, Amazon will reject your badge request and you must correct the issues and resubmit your product for certification. For submission instructions, see Submit your product for certification.