Defined Interfaces for the Alexa Gadgets Toolkit


At a high level, an Echo device sends a gadget directives. The gadget sends events to the Echo device. For example, the Echo device might send a directive to notify the gadget that a timer on the Echo device expired. The gadget might send the Echo device an event that reports its capabilities.

Directives and events are grouped into interfaces. Some interfaces are common across Alexa Voice Service (AVS), whereas some interfaces are for gadgets only. The following table contains the complete list of interfaces that gadgets support.

Interface Purpose Directives Events

Alerts

Provides directives that instruct your gadget to set a timer, alarm, or reminder for a specific time or duration, or to delete a timer that is set.

SetAlert
DeleteAlert

None

Alexa.Discovery

Queries the gadget for its details and capabilities.

Discover

Discover.Response

Alexa.Gadget.MusicData

Sends your gadget tempo data for Amazon Music that the Echo device is playing.

Tempo

None

Alexa.Gadget.SpeechData

Provides your gadget speechmark data that enables the gadget to synchronize speech with visual experiences.

Speechmarks

None

Alexa.Gadget.StateListener

Informs your gadget when an alarm, timer, or reminder is started or stopped, and when the wake word is detected. Also provides your gadget with time information from the Echo device.

StateUpdate

None

Notifications

Enables the gadget to inform users that new content is available from Alexa domains or an enabled Alexa skill.

SetIndicator
ClearIndicator

None


Was this page helpful?

Last updated: Feb 14, 2022