<!--
{
  "availability" : [

  ],
  "documentType" : "symbol",
  "framework" : "SiriEventSuggestionsMarkup",
  "identifier" : "/documentation/SiriEventSuggestionsMarkup",
  "metadataVersion" : "0.1.0",
  "role" : "Framework",
  "symbol" : {
    "kind" : "Framework",
    "modules" : [
      "Siri Event Suggestions Markup"
    ],
    "preciseIdentifier" : "SiriEventSuggestionsMarkup"
  },
  "title" : "Siri Event Suggestions Markup"
}
-->

# Siri Event Suggestions Markup

Update users’ calendars and inform suggestions from Siri with reservation data embedded in email and webpages.

## Overview

You can use the Siri Event Suggestions Markup data format to provide event details in webpages and emails. Siri parses travel arrangements, shows, restaurant reservations, and social events in order to augment related activities, like suggesting driving directions or a ride share to a scheduled event and activating Do Not Disturb just before a show starts.

When Mail receives an email or Safari loads a webpage with reservation markup, Siri also adds the event to the user’s Siri Event Suggestions calendar. Mail and Safari also inform the user that the content they’re viewing includes a reservation, so the user can accept or reject the event without leaving their current activity.

![A diagram of the Siri Event Suggestions Markup process, which begins with a graphic representing a piece of reservation data. An arrow points from the reservation graphic to a Siri icon, and from the Siri icon to a calendar, a driving directions graphic, and a Siri Suggestion containing the text “Time to check-in” and “Reservation found in Mail”.](images/com.apple.sirieventsuggestionsmarkup/media-3672141@2x.png)

Include reservation markup data when you communicate about confirmed reservations with your users. Use a consistent [`reservationId`](/documentation/SiriEventSuggestionsMarkup/reservationId) each time, so the system can manage duplicates between Safari and Mail and across the user’s devices.

Fill out the form at [Siri Event Suggestions Markup Information](https://developer.apple.com/contact/request/siri-events/) to request inclusion in the domain allow list for event suggestion processing. See [Checking Your Reservation Markup](/documentation/SiriEventSuggestionsMarkup/checking-your-reservation-markup) for more details about testing your implementation before you apply.

> Tip:
> Donate reservation information from your app as well, if you have one. For more information about providing event suggestions from your app, see <doc://com.apple.documentation/documentation/SiriKit/siri-event-suggestions>.

### Format Reservation Data

If you offer reservations on a website or email reservation confirmations to users, you may provide reservation information embedded in HTML documents as either JSON-LD or Microdata. For JSON-LD, specify the [`@context`](/documentation/SiriEventSuggestionsMarkup/@context) and `@type,` as shown in this example:

```xml
<script type="application/ld+json">
{
  "@context": "http://schema.org", 
  "@type": "TrainReservation",
  "reservationId": "ASDF1234"
  /* more data goes here */    
}
</script>
```

For Microdata, provide the schema.org URL for the reservation in an `itemtype` attribute like this:

```xml
<section itemscope itemtype="http://schema.org/TrainReservation">
Your reservation
<span itemprop="reservationId">ASDF1234</span>
is confirmed!
/* more data goes here */
</section>
```

## Topics

### Essentials

[Providing Trusted Data](/documentation/SiriEventSuggestionsMarkup/providing-trusted-data)

Sign your content and avoid sending unnecessary or inaccurate information.

[Checking Your Reservation Markup](/documentation/SiriEventSuggestionsMarkup/checking-your-reservation-markup)

Preview your reservation event data before the Allow List includes your domain.

### Transportation

[`FlightReservation`](/documentation/SiriEventSuggestionsMarkup/FlightReservation)

An airplane flight reservation.

[`TrainReservation`](/documentation/SiriEventSuggestionsMarkup/TrainReservation)

A reservation for train travel.

[`BusReservation`](/documentation/SiriEventSuggestionsMarkup/BusReservation)

A reservation for bus travel.

[`BoatReservation`](/documentation/SiriEventSuggestionsMarkup/BoatReservation)

A reservation for boat travel.

[`RentalCarReservation`](/documentation/SiriEventSuggestionsMarkup/RentalCarReservation)

A reservation to rent a car.

### Food, Lodging, and Events

[`EventReservation`](/documentation/SiriEventSuggestionsMarkup/EventReservation)

A reservation for a movie, sporting event, live show, or other scheduled event.

[`FoodEstablishmentReservation`](/documentation/SiriEventSuggestionsMarkup/FoodEstablishmentReservation)

A restaurant reservation.

[`LodgingReservation`](/documentation/SiriEventSuggestionsMarkup/LodgingReservation)

A hotel reservation or other booking for a place to stay.

### Common Reservation Data

[`Person`](/documentation/SiriEventSuggestionsMarkup/Person)

A passenger, diner, lodging guest, or event attendee.

[`Ticket`](/documentation/SiriEventSuggestionsMarkup/Ticket)

Details about a ticket for transportation or an event.

[`Seat`](/documentation/SiriEventSuggestionsMarkup/Seat)

The specific location reserved for the passenger.

[`Organization`](/documentation/SiriEventSuggestionsMarkup/Organization)

A business, transportation provider, or event organizer.

[`Place`](/documentation/SiriEventSuggestionsMarkup/Place)

A business, transportation hub, or event venue.

[`PostalAddress`](/documentation/SiriEventSuggestionsMarkup/PostalAddress)

A specific geographic location.

### Basic Data Types

[`@context`](/documentation/SiriEventSuggestionsMarkup/@context)

The open standard reference for interpreting the markup contents.

[`dateTimeISO8601`](/documentation/SiriEventSuggestionsMarkup/dateTimeISO8601)

A time and date in the ISO-8601 format.

[`reservationId`](/documentation/SiriEventSuggestionsMarkup/reservationId)

A stable, unique identifier for the reservation.

[`reservationStatus`](/documentation/SiriEventSuggestionsMarkup/reservationStatus)

A string indicating that the reservation has been confirmed or canceled.

[`URL`](/documentation/SiriEventSuggestionsMarkup/URL)

The address of a webpage.

[`telephone`](/documentation/SiriEventSuggestionsMarkup/telephone)

A phone number.



---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)