Alexa Skill Development Event Schemas

Note: Sign in to the developer console to build or publish your skill.

The Skill Development Notifications Service (SDNS) enables you to receive notifications about Alexa skill development events that you trigger by 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, interaction model updates, and when a customer reviews your skill.

For an overview of SDNS and the steps to set up notifications, see Use the Alexa Skill Development Notifications. 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
`AlexaCustomerFeedbackEvent.SkillReviewPublish`	A customer wrote a review of your skill and gave the skill a star rating. This event doesn't include star ratings that aren't accompanied by a text review.	Skill review
`AlexaDevelopmentEvent.ALL`	All skill development events with prefix `AlexaDevelopmentEvent`.	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 unique ID of the subscription that subscribes to the event that triggered this notification.

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.
`eventName`	`AlexaDevelopmentEvent.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 unique ID of the subscription that subscribes to the event that triggered this notification.

Skill review event schema

This event signifies that a customer wrote a review of your skill and gave the skill a star rating. This event doesn't include star ratings that aren't accompanied by a text review.

The following is an example of a skill review event.

{   
  "timestamp": "2020-02-20T22:40:19.746Z",
  "eventName": "AlexaCustomerFeedbackEvent.SkillReviewPublish",
  "payload": {
    "subscription": {
      "subscriptionId": "testSubscriptionId"
    },
    "skill": {
      "skillId": "amzn1.ask.skill.abcabcabcabcabcabc",
      "vendorId": "MT2ZSER56DY76BA"
    },
    "review": {
      "reviewId" : "123ABCEXAMPLE",
      "url": "example.com",
      "starRating": 5
    }
  }
}

Parameters

Parameter	Description
`timestamp`	ISO 8601 timestamp for when the customer review was published for the skill.
`eventName`	The name of the event that triggered the notification, which is `AlexaCustomerFeedbackEvent.SkillReviewPublish`.
`payload`	Payload object.
`payload.subscription`	The subscription object that triggered notification of this event.
`payload.subscription.subscriptionId`	The unique ID of the subscription that subscribes to the event that triggered this notification.
`payload.skill`	An object that represents the skill that caused this event.
`payload.skill.skillId`	The skill ID of the skill for which the review was published.
`payload.skill.vendorId`	The vendor ID of the Amazon developer account to which the reviewed skill belongs.
`payload.review`	An object that represents the skill review.
`payload.review.reviewId`	The unique identifier for a review. Remains the same on review updates.
`payload.review.url`	The URL that redirects you to the review page on the Amazon website.
`payload.review.starRating`	The star rating provided by the customer. Possible values: 1, 2, 3, 4, or 5.

Last updated: May 11, 2023