Alexa Skill Development Event Schemas

The Skill Development Notifications Service (SDNS) enables you to receive notifications about Alexa skill development events that you trigger using the Alexa Skill Management API (SMAPI) or the Alexa Skills Kit Command-Line Interface (ASK CLI). This topic describes the schemas for the events, which include skill manifest updates, certification updates, publish-to-live updates, and interaction model updates.

For an overview of SDNS and the steps to set up notifications, see Use the Alexa Skill Development Notifications API. For SDNS API operations, see Alexa Skill Development Notifications API Reference.

Skill development events

The following table contains the skill development events for which you can subscribe to receive notifications.

Event Name Description Schema
AlexaDevelopmentEvent.ALL All skill development events that SDNS supports.

Depends on the event type
AlexaDevelopmentEvent.InteractionModelUpdate The status of a set/update interaction model request.

Interaction model update
AlexaDevelopmentEvent.ManifestUpdate The status of the update request on the skill manifest. This event is generated when a request to create a skill or update an existing skill is completed.

Skill update
AlexaDevelopmentEvent.SkillCertification The status of non-basic validations of the certification workflow.

Skill update
AlexaDevelopmentEvent.SkillPublish Represents the status of the publish-to-live operation. When a developer submits a skill for certification, it goes through certification workflow followed by the publish-to-live workflow. This event is generated in the publish-to-live workflow.

Skill update

Skill update event schema

The following is an example of a skill update event.

{
   "requestId":"aaaa-bbbb-cccc-example",
   "timestamp":"2020-01-07T23:08:13Z",
   "eventName":"AlexaDevelopmentEvent.ManifestUpdate",
   "payload":
   {
      "status":"SUCCEEDED",
      "actor":
      {
         "customerId":"amzn1.account.123456example"
      },
      "subscription":
      {
         "subscriptionId":"amzn1.ask-subscription.123456-example"
      },
      "skill":
      {
         "skillId":"amzn1.ask.skill.123456-example",
         "vendorId":"M123456EXAMPLE"
      }
   }
}

Parameters

Parameter Description
requestId A unique identifier that represents the original request that resulted in the skill development notification. Amazon APIs return the requestId for the original request in the X-Amzn-RequestId header of the response.
timestamp ISO 8601 timestamp for the instant that the event was created.
eventName The name of the event that triggered the notification. One of:
  • AlexaDevelopmentEvent.ManifestUpdate
  • AlexaDevelopmentEvent.SkillPublish
  • AlexaDevelopmentEvent.SkillCertification
payload Payload object.
payload.status

Status string that represents the completion status of the request. One of: SUCCEEDED or FAILED.

For AlexaDevelopmentEvent.SkillPublish events, SUCCEEDED means that users can see and enable the latest version of the skill through the Alexa Skill Store.
payload.actor An object that represents an actor that submitted a request causing this event.
payload.actor.customerId A unique identifier that represents the Amazon customer who submitted a request that corresponds to the generated event.
payload.skill An object that represents the skill that caused this event.
payload.skill.skillId The skill ID of the skill that caused this event.
payload.skill.vendorId The vendor ID of the Amazon developer account to which this skill belongs.
subscription The subscription object that triggered notification of this event.
subscription.subscriptionId The subscription ID that triggered the event subscription that triggered notification of this event.

Interaction model update event schema

The following is an example of an interaction model update event.

{
   "requestId":"aaaa-bbbb-cccc-example",
   "timestamp":"2020-01-07T23:08:13Z",
   "eventName":"AlexaDevelopmentEvent.InteractionModelUpdate",
   "payload":
   {
      "status":"SUCCEEDED",
      "actor":
      {
         "customerId":"amzn1.account.123456example"
      },
      "interactionModel":
      {
         "skillId":"amzn1.ask.skill.123456-example",
         "vendorId":"M123456EXAMPLE",
         "locale":"en-US"
      },
      "subscription":
      {
         "subscriptionId":"amzn1.ask-subscription.123456-example"
      }
   }
}

Parameters

Parameter Description
requestId A development notification includes a unique identifier that identifies the original request that resulted in the development notification. The requestId for the original request is returned by Amazon APIs in the response's X-Amzn-RequestId header.
timestamp ISO 8601 timestamp for the instant when event was created.
eventNameAlexaDevelopmentEvent.InteractionModelUpdate
payload Payload object.
payload.status Status string that represents the completion status of the request. One of: SUCCEEDED or FAILED.
payload.actor An object that represents an actor that submitted a request causing this event.
payload.actor.customerId A unique identifier that represents the Amazon customer who submitted a request that corresponds to the generated event.
payload.interactionModel An object that represents the interaction model that caused this event.
payload.interactionModel.skillId The skill ID of the skill that caused this event.
payload.interactionModel.vendorId The vendor ID of the Amazon developer account to which this skill belongs.
payload.interactionModel.locale The locale of the interaction model, such as en-US.
subscription The subscription object that triggered notification of this event.
subscription.subscriptionId The subscription ID that triggered the event subscription that triggered notification of this event.
Amazon Alexa
Amazon Appstore
Amazon Web Services
Amazon Dash Replenishment