| Event type | Sent when | Available |
|---|---|---|
reservation.created | A booking is made, on a channel, direct, as a walk-in or from a group | First release |
reservation.modified | Anything about the reservation changes: dates, room type, guest count, rate plan, guest name or status | First release |
reservation.room_assigned | A room is allocated before arrival | Later |
reservation.checked_in | The guest arrives | Later |
reservation.room_moved | The guest changes room during the stay, including an upgrade | Later |
reservation.stay_extended | The guest adds nights | Later |
reservation.stay_shortened | The guest leaves early | Later |
reservation.checked_out | The guest departs | Later |
reservation.cancelled | The booking is cancelled, on a channel or at the property | Later |
reservation.no_show | The guest never arrived, found at night audit | Later |
reservation.expired | An unconfirmed hold lapses | Later |
reservation.modified. Read status.bookingStatus, reservedRoom, rooms and the dates in the payload to tell which change it was. When one of them is released, the Changelog will say whether reservation.modified is still sent for the same change.| Event type | Sent when | Available |
|---|---|---|
guest.created | A guest profile is created, with a booking, at check-in or on its own | First release |
guest.modified | A guest's name, contact details, address, nationality, language or preferences change | First release |
| Event type | Sent when | Available |
|---|---|---|
room.updated | A room's details change | Later |
rate.updated | A rate, availability or restriction changes, including minimum stay, closed to arrival or departure, and stop-sell | Later |
| Event type | Sent when | Available |
|---|---|---|
menu_item.created | A menu item is added | Later |
menu_item.updated | A menu item changes, including being made inactive | Later |
outlet_menu_item.created | An item is added to an outlet's menu | Later |
outlet_menu_item.updated | An outlet's menu item changes, including its price, or is made inactive | Later |
updated event with status set to Inactive.data differs by event type. The outer fields are described in Set Up and Edit Webhooks, and the tables below describe data.data are in the property's local time, with no offset; createdAt is in UTC with an offset. The examples are formatted for reading; the body you receive is compact JSON with no spaces or line breaks, so check the signature against the bytes you receive, never against a copy of these examples.reservation.created to reservation.expired, carries the reservation as it is after the change, not only the fields that changed. The example is the reservation.modified event sent when a guest checks in, so status.bookingStatus is CheckedIn and rooms holds the check-in details.| Field | Description |
|---|---|
reservationNo | The reservation's unique number. Use it to match events to a reservation |
bookingNo | The booking number. Every reservation in a group booking shares it |
onlineBookingRefNo | The booking reference from the online channel; null when not booked online |
booking | Booking, arrival and departure dates and times, nights, rooms booked, currency, the booker's contactEmail and contactMobile, the deposit and the total room rate |
partyName | The company, agent or channel the booking is made under |
occupancy | Adults, children and total guests (pax) |
roomType, ratePlan | The booked room type and rate plan, each with its code and name |
reservedRoom | The room number allocated; null until a room is assigned |
rooms | One entry per room checked in, with its room number, guest, room type, rate plan, occupancy, checkIn and checkOut details. Empty before arrival. Before the guest checks out, checkOut can already hold the planned departure |
tariff | The nightly room rate |
status.bookingStatus | One of Confirmed, WaitingList, Tentative, Provisional, CheckedIn, CheckedOut, Cancelled, NoShow, TurnAway or Unknown |
status.cancellation | null unless cancelled; then cancellationNo, date, reason, requestedBy and cancelledBy |
source | The channel (OTA, Direct, Corporate, TravelAgent or Unknown), business source, market segment and travel agent |
specialRequests | The guest's instructions, message and remarks |
guestDetails | The guests on the reservation, numbered by guestSno from 1. guestId matches the guestId in guest events |
lastModifiedDate | When the reservation was last changed |
booking.currency and can carry up to four decimal places. A text field with no value can arrive as null or as an empty string; treat both as empty.guest.created and guest.modified. The guest's profile as it is after the change. The guest's bookings arrive as reservation events.| Field | Description |
|---|---|
guestId | The guest's unique ID. It matches guestId in a reservation's guestDetails |
title | The guest's title, with its code and name |
guestName | The guest's name as stored in WinCloud |
firstName, lastName | The guest's first and last name |
gender, dateOfBirth | null when not recorded |
email, mobile, phone | The guest's contact details |
address | The guest's address |
nationality, countryOfResidence | Each with its WinCloud code, name and ISO 3166-1 alpha-3 isoCode |
language | The guest's language; null when not recorded |
isPreferredGuest | true for a preferred guest |
preferences | Likes, dislikes, favourite room, hotel comment and preference notes |
guest.modified events for one guest arrive out of order, keep the one with the later createdAt.menu_item.created and menu_item.updated. The item as it is on the property's master menu. It has no outlet, price or tax; those belong to the outlet menu item.| Field | Description |
|---|---|
companyId | The company within the property |
productId, productName | The menu item |
productGroupId, productGroupName | The item's group, for example Food |
productSubGroupId, productSubGroupName | The item's sub-group |
status | Active or Inactive, after the change |
lastUpdated | When the item was last changed |
outlet_menu_item.created and outlet_menu_item.updated. The item as it is sold at one outlet, with its price and tax.| Field | Description |
|---|---|
companyId, outletId | The company and the POS outlet |
productId, productName | The menu item |
productGroupId, productGroupName | The item's group, for example Food |
productSubGroupId, productSubGroupName | The item's sub-group |
price | The item's price at this outlet |
taxStructureId | The tax structure applied to the item |
status | Active or Inactive, after the change |
lastUpdated | When the item was last changed |