Gracias por tu visita. Esta página solo está disponible en inglés.

Proactive Events Schemas

See ProactiveEvents API for more information about setting up your skill service to use proactive events. This document describes event schemas that are supported by the ProactiveEvents API. If you need other schemas, please enter your request at Alexa Skills - User Voice and Vote.

Event name convention and template

This format is used for all of the proactive event schemas. The event name is prefixed with AMAZON. as the namespace. The event name itself consists of two parts, with the two parts split with '.'. The first part of the event name specifies the subject that is described by the event, and the second part of the event name describes the reason that causes the event to be generated.

The structure template is as follows:

{
    "name": "AMAZON.EventNamePartOne.EventNamePartTwo",
    "payload": {
        "sampleAttribute": {
            "nestedStringAttribute": "sampleValue"
        },
        "anotherSampleAttribute": {
            "nestedIntegerAttribute": 1,
            "nestedFloatAttribute": 10.5
        }
    }
}

Event catalog

This list the types of events you can use in your skill.

Event description Sample notification Event name
Weather alert There is a tornado alert for your area. Provided by Weather Knows. AMAZON.WeatherAlert.Activated
Sports event update TreeFruit League match update, Oranges 1, Apples 2 AMAZON.SportsEvent.Updated
Message reminder You have three new urgent messages from Barbara AMAZON.MessageAlert.Activated
Order status update Your preorder from Amazon has been received
Your order from Amazon has been received
Your order from Amazon is being prepared
Your order from Amazon has been shipped and will arrive by May 18, 2019
Your order from Amazon is out for delivery and will arrive by May 20, 2019
Your order from Amazon was delivered on May 2, 2019
Your order from Amazon has been delivered
AMAZON.OrderStatus.Updated
Reservation confirmation Your appointment at Dental XYZ for a root canal on May 10, 2019 has been confirmed AMAZON.Occasion.Updated
Trash collection reminder This coming Tuesday is glass collection day AMAZON.TrashCollectionAlert.Activated
Media content availability notification Salvage Hunters will air on
January 3, 2019 on Amazon Video
AMAZON.MediaContent.Available
Social game invitation notification Your friend John Jones has invited you to a game of chess AMAZON.SocialGameInvite.Available

AMAZON.WeatherAlert.Activated

Purpose: Weather alert

User notification: "There is a <weatherAlert.alertType> alert for your area. Provided by <weatherAlert.source>."

The sentence "Provided by <weatherAlert.source>." will be omitted if no source is provided.

payload parameters

Parameters for the payload object.

Name Required Type Multi-Locale Support Description
weatherAlert Yes WeatherAlert
weatherAlert.source No String Yes
weatherAlert.alertType Yes WeatherAlertType One of: TORNADO, HURRICANE, SNOW_STORM, THUNDER_STORM

localizedAttributes parameters

These parameters are used for each item in the localizedAttributes array. Each item includes a locale and source, so each supported locale has an item in the array.

Name Required Type Description
locale Yes enum One of the supported locales, such as "en-US"
source Yes string Information source

Example

{
  "name": "AMAZON.WeatherAlert.Activated",
  "payload": {
    "weatherAlert": {
      "source": "localizedattribute:source",
      "alertType": "TORNADO"
    }
  },
  "localizedAttributes": [
    {
      "locale": "en-US",
      "source": "Weather Knows"
    }
  ]
}

AMAZON.SportsEvent.Updated

Purpose: Soccer event score update

User notification: "<sportsEvent.eventLeague.name> match update, <update.teamName> scored! <sportsEvent.awayTeamStatistic.team.name> <sportsEvent.awayTeamStatistic.score>, <sportsEvent.homeTeamStatistic.team.name> <sportsEvent.homeTeamStatistic.score>"

payload parameters

Parameters for the payload object.

Name Required Type Multi-Locale Support
update No Goal
update.scoreEarned Yes integer
update.teamName Yes string No
sportsEvent Yes SportsEvent
sportsEvent.eventLeague Yes Soccer
sportsEvent.eventLeague.name Yes string Yes
sportsEvent.homeTeamStatistic Yes GameStatistic
sportsEvent.homeTeamStatistic.team Yes SportsTeam
sportsEvent.homeTeamStatistic.team.name Yes string No
sportsEvent.homeTeamStatistic.score Yes integer
sportsEvent.awayTeamStatistic Yes GameStatistic
sportsEvent.awayTeamStatistic.team Yes SportsTeam
sportsEvent.awayTeamStatistic.team.name Yes string No
sportsEvent.awayTeamStatistic.score Yes integer  

localizedAttributes parameters

These parameters are used for each item in the localizedAttributes array. Each item includes a locale and eventLeagueName, so each supported locale has an item in the array.

Name Required Type Description
locale Yes enum One of the supported locales, such as "en-US"
eventLeagueName Yes string Name of the league for the event

Example

{
  "name": "AMAZON.SportsEvent.Updated",
  "payload": {
    "update": {
      "scoreEarned": 1,
      "teamName": "Apples"
    },
    "sportsEvent": {
      "eventLeague": {
        "name": "localizedattribute:eventLeagueName"
      },
      "homeTeamStatistic": {
        "team": {
          "name": "Oranges"
        },
        "score": 1
      },
      "awayTeamStatistic": {
        "team": {
          "name": "Apples"
        },
        "score": 2
      }
    }
  },
  "localizedAttributes": [
    {
      "locale": "en-US",
      "eventLeagueName": "TreeFruit League"
    }
  ]
}

AMAZON.MessageAlert.Activated

Purpose: Message reminder

User notification: "You have <messageGroup.count> <state.freshness> <state.status> <urgency> message/messages from <messageGroup.creator.name>".

payload parameters

Parameters for the payload object.

Name Required Type Multi-Locale Support Description
state Yes MessageState
state.status Yes MessageStatus One of: UNREAD, FLAGGED
state.freshness No MessageFreshness One of: NEW, OVERDUE
messageGroup Yes MessageGroup
messageGroup.creator Yes Person
messageGroup.creator.name Yes string No
messageGroup.count Yes integer
messageGroup.urgency No urgency If used, the value is URGENT.

Example

{
  "name": "AMAZON.MessageAlert.Activated",
  "payload": {
    "state": {
      "status": "UNREAD",
      "freshness": "NEW"
    },
    "messageGroup": {
      "creator": {
        "name": "Andy"
      },
      "count": 5,
      "urgency": "URGENT"
    }
  }
}

AMAZON.OrderStatus.Updated

Purpose: Order status update

User notification: The user experience will depend on the OrderStatus enum value, as follows:

  • PREORDER_RECEIVED: Your preorder from <order.seller.name> has been received
  • ORDER_RECEIVED: Your order from <order.seller.name> has been received
  • ORDER_PREPARING: Your order from <order.seller.name> is being prepared
  • ORDER_SHIPPED: Your order from <order.seller.name> has been shipped and will arrive by <state.deliveryDetails.expectedArrival>
  • ORDER_OUT_FOR_DELIVERY: Your order from <order.seller.name> is out for delivery and will arrive by <state.deliveryDetails.expectedArrival>
  • ORDER_DELIVERED: Your order from <order.seller.name> was delivered on <state.deliveredOn>
  • ORDER_DELIVERED: Your order from <order.seller.name> has been delivered

payload parameters

Parameters for the payload object.

Name Required Type Multi-Locale Support Description
state Yes OrderState
state.status Yes OrderStatus One of: PREORDER_RECEIVED, ORDER_RECEIVED, ORDER_PREPARING, ORDER_SHIPPED, ORDER_OUT_FOR_DELIVERY, ORDER_OUT_FOR_DELIVERY, ORDER_DELIVERED
state.enterTimeStamp No dateTime
state.deliveryDetails No ParcelDelivery
order Yes Order

localizedAttributes parameters

These parameters are used for each item in the localizedAttributes array. Each item includes a locale and sellerName, so each supported locale has an item in the array.

Name Required Type Description
locale Yes enum One of the supported locales, such as "en-US"
sellerName Yes string Name of the seller

Examples

Your preorder from <order.seller.name> has been received:

{
  "name": "AMAZON.OrderStatus.Updated",
  "payload": {
    "state": {
      "status": "PREORDER_RECEIVED"
    },
    "order": {
      "seller": {
        "name": "localizedattribute:sellerName"
      }
    }
  },
  "localizedAttributes": [
    {
      "locale": "en-US",
      "sellerName": "Amazon"
    },
    {
      "locale": "ru-RU",
      "sellerName": "Amazon"
    }
  ]
}

Your order from <order.seller.name> has been received:

{
  "name": "AMAZON.OrderStatus.Updated",
  "payload": {
    "state": {
      "status": "ORDER_RECEIVED"
    },
    "order": {
      "seller": {
        "name": "localizedattribute:sellerName"
      }
    }
  },
  "localizedAttributes": [
    {
      "locale": "en-US",
      "sellerName": "Amazon"
    },
    {
      "locale": "ru-RU",
      "sellerName": "Amazon"
    }
  ]
}

Your order from <order.seller.name> has been shipped and will arrive <date>:

{
  "name": "AMAZON.OrderStatus.Updated",
  "payload": {
    "state": {
      "status": "ORDER_SHIPPED",
      "deliveryDetails": {
        "expectedArrival": "2018-11-23T18:25:43.511Z"
      }
    },
    "order": {
      "seller": {
        "name": "localizedattribute:sellerName"
      }
    }
  },
  "localizedAttributes": [
    {
      "locale": "en-US",
      "sellerName": "Amazon"
    },
    {
      "locale": "ru-RU",
      "sellerName": "Amazon"
    }
  ]
}

Your order from <order.seller.name> is out for delivery, and will arrive by <datetime>:

{
  "name": "AMAZON.OrderStatus.Updated",
  "payload": {
    "state": {
      "status": "ORDER_OUT_FOR_DELIVERY",
      "deliveryDetails": {
        "expectedArrival": "2018-11-23T18:25:43.511Z"
      }
    },
    "order": {
      "seller": {
        "name": "localizedattribute:sellerName"
      }
    }
  },
  "localizedAttributes": [
    {
      "locale": "en-US",
      "sellerName": "Amazon"
    },
    {
      "locale": "ru-RU",
      "sellerName": "Amazon"
    }
  ]
}

Your order from <order.seller.name> was delivered <date>:

{
  "name": "AMAZON.OrderStatus.Updated",
  "payload": {
    "state": {
      "status": "ORDER_DELIVERED",
      "deliveredOn": "2018-11-23T18:25:43.511Z"
    },
    "order": {
      "seller": {
        "name": "localizedattribute:sellerName"
      }
    }
  },
  "localizedAttributes": [
    {
      "locale": "en-US",
      "sellerName": "Amazon"
    },
    {
      "locale": "ru-RU",
      "sellerName": "Amazon"
    }
  ]
}

Your order from <order.seller.name> has been delivered:

{
  "name": "AMAZON.OrderStatus.Updated",
  "payload": {
    "state": {
      "status": "ORDER_DELIVERED"
    },
    "order": {
      "seller": {
        "name": "localizedattribute:sellerName"
      }
    }
  },
  "localizedAttributes": [
    {
      "locale": "en-US",
      "sellerName": "Amazon"
    },
    {
      "locale": "ru-RU",
      "sellerName": "Amazon"
    }
  ]
}

AMAZON.Occasion.Updated

Purpose: Reservation confirmation

User notification: "Your <occasion.occasionType> at <occasion.provider.name> for <occasion.subject> on <occasion.bookingTime> has been <state.confirmationStatus>. Please say 'ask <skill name> to review'".

payload parameters

Parameters for the payload object.

Name Required Type Multi-Locale Support Description
state Yes ConfirmationState
state.confirmationStatus Yes ConfirmationStatus  One of: CONFIRMED, CANCELED, RESCHEDULED, REQUESTED, CREATED, UPDATED
occasion Yes Occasion
occasion.occasionType Yes OccasionType One of: RESERVATION_REQUEST, RESERVATION, APPOINTMENT_REQUEST, APPOINTMENT
occasion.subject Yes string Yes
occasion.provider Yes Organization
occasion.provider.name Yes string Yes
occasion.bookingTime Yes dateTime
occasion.broker No Skill
occasion.broker.name Yes string Yes

localizedAttributes parameters

These parameters are used for each item in the localizedAttributes array. Each supported locale has an item in the array.

Name Required Type Description
locale Yes enum One of the supported locales, such as "en-US"
subject Yes string Description of the appointment or reservation, such as "root canal"
providerName Yes string Name of the provider, such as the doctor's or restaurant's name
brokerName Yes string Name of the broker, which may be the same as providerName, or a third party

Example

{
  "name": "AMAZON.Occasion.Updated",
  "payload": {
    "state": {
      "confirmationStatus": "CONFIRMED"
    },
    "occasion": {
      "occasionType": "APPOINTMENT",
      "subject": "localizedattribute:subject",
      "provider": {
        "name": "localizedattribute:providerName"
      },
      "bookingTime": "2018-11-20T19:16:31Z",
      "broker": {
        "name": "localizedattribute:brokerName"
      }
    }
  },
  "localizedAttributes" : [
    {
      "locale": "en-US",
      "subject": "root canal",
      "providerName": "Dental XYZ",
      "brokerName": "Dental XYZ"
    }
  ]
}

AMAZON.TrashCollectionAlert.Activated

Purpose: Trash collection reminder

User notification: "The coming <alert.collectionDayOfWeek> is <alert.garbageTypes*> collection day"

payload parameters

Parameters for the payload object.

Name Required Type Multi-Locale Support Description
alert Yes TrashCollectionAlert
alert.garbageTypes Yes GarbageType[] A list of GarbageType values, with a size between 1-5. Possible values include: BOTTLES, BULKY, BURNABLE, CANS, CLOTHING, COMPOSTABLE, CRUSHABLE, GARDEN_WASTE, GLASS, HAZARDOUS, HOME_APPLIANCES, KITCHEN_WASTE, LANDFILL, PET_BOTTLES, RECYCLABLE_PLASTICS, WASTE_PAPER
alert.collectionDayOfWeek Yes DayOfWeek One of: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY

Event

{
  "name": "AMAZON.TrashCollectionAlert.Activated",
  "payload": {
    "alert": {
      "garbageTypes": [
        "COMPOSTABLE",
        "RECYCLABLE_PLASTICS"
      ],
      "collectionDayOfWeek": "TUESDAY"
    }
  }
}

AMAZON.MediaContent.Available

Purpose: Provides information about when a particular creative work is available, and on which provider.

User notification: "<content.name> will <availability.method> on <availability.startTime> on <availability.provider.name>"

payload parameters

Parameters for the payload object.

Name Required Type Multi-Locale Support Description
availability Yes Availability Provides availability information
availability.startTime Yes string
availability.provider No Thing Provider information
availability.provider.name Yes string Yes Name of the provider
availability.method Yes DistributionMethod Method of distribution. One of: STREAM, AIR, RELEASE, PREMIERE, DROP.
content Yes CreativeWork Contains information about the creative work
content.name Yes string Yes Name of the creative work.
content.contentType Yes MediaTypes One of: BOOK, EPISODE, ALBUM, SINGLE, MOVIE, GAME

localizedAttributes parameters

These parameters are used for each item in the localizedAttributes array. Each item includes a locale, providerName, and contentName, so each supported locale has an item in the array.

Name Required Type Description
locale Yes enum One of the supported locales, such as "en-US"
providerName Yes string Content provider name, such as "Amazon Video"
contentName Yes string Name of the content, such as "Salvage Hunters"

Event

{
  "name": "AMAZON.MediaContent.Available",
  "payload": {
    "availability": {
      "startTime": "2028-11-20T21:00:00Z",
      "provider": {
        "name": "localizedattribute:providerName"
      },
      "method": "AIR"
    },
    "content": {
      "name": "localizedattribute:contentName"
    }
  },
  "localizedAttributes": [
    {
      "locale": "en-US",
      "providerName": "Amazon Video",
      "contentName": "Salvage Hunters"
    }
  ]
}

AMAZON.SocialGameInvite.Available

Purpose: Send a notification of an invitation to a game

"User notification: "Your <invite.inviter.relationshipToInvitee> <invite.inviter.name> has <invite.inviteType> you to a <game.offer> of <game.name>""

payload parameters

Parameters for the payload object.

Name Required Type Multi-Locale Support Description
invite Yes GameInvite Object that contains invite information.
invite.inviter Yes Person Object that contains information about the inviter.
invite.inviter.name Yes string No Name of the inviter.
invite.inviter.relationshipToInvitee Yes enum One of: FRIEND, CONTACT
invite.inviter.inviteType Yes enum One of: CHALLENGE, INVITE
game Yes Game Object that contains game information
game.offer Yes OfferType One of: MATCH, REMATCH, GAME
game.name Yes string Name of the game

localizedAttributes parameters

These parameters are used for each item in the localizedAttributes array. Each item includes a locale and gameName, so each supported locale has an item in the array.

Name Required Type Description
locale Yes enum One of the supported locales, such as "en-US"
gameName Yes string Name of the game, which may vary by locale

Event

{
  "name": "AMAZON.SocialGameInvite.Available",
  "payload": {
    "invite": {
      "relationshipToInvitee": "FRIEND",
      "inviter": {
        "name": "Max"
      },
      "inviteType": "CHALLENGE"
    },
    "game": {
      "offer": "GAME",
      "name": "localizedattribute:gameName"
    }
  },
  "localizedAttributes": [
    {
      "locale": "en-US",
      "gameName": "The Red"
    },
    {
      "locale": "fr-FR",
      "gameName": "Le rouge"
    }	
  ]
}