1. Webhooks
WinCloud API
  • Getting Started
    • Introduction
    • Quick Start
    • Authentication
    • General
    • Changelog
    • Privacy Policy
    • Terms of Service
    • Support
  • APIs
    • Guests
      • Search Guests
      • Create Guest
      • Get Guest Details
      • Update Guest
      • Get Guest Reservations
      • Get Guest Reference Data
    • Inventory
      • Get Room Inventory
      • Get Room Inventory Details
      • Update Room Inventory
    • Properties
      • Get Customer Properties
      • Get Property Configuration
    • Rates
      • Get Rate Adjustment Templates
      • Get Master Rates
      • Post Master Rates
      • Post Individual Rates
    • Reference Data
      • Get Countries
      • Get Payment Gateways
      • Get Payment Methods
      • Get Currencies
    • Reservations v1
      • Get Reservations
      • Get Cancelled Reservations
      • Get No-Show Reservations
      • Get Reservation Statuses
      • Update Special Instructions
    • Reservations v2
      • List Reservations
      • Get Reservation
    • Rooms
      • Get Rooms
      • Get Room Types
      • Get Rooms Extra Charges
      • Get Rooms Feature Types
      • Get Rooms Tariffs
      • Get Room and Revenue Performance
    • Travel Agents
      • Get Active Travel Agents
    • POS
      • Get Outlet Menu
    • Booking Analytics
      • Get Arrival Summary
      • Get Booking Summary
    • Schemas
      • CodeNameDto
      • ArrivalFiguresDto
      • CompanyDto
      • ArrivalSummaryDto
      • CompanyDtoPaginatedResponse
      • ArrivalSummaryDtoApiResponse
      • CompanyDtoPaginatedResponseApiResponse
      • BookingSummaryDto
      • CountryDto
      • ConfigurationOutletDto
      • BookingSummaryDtoApiResponse
      • CountryDtoApiResponse
      • ConfigurationRoomTypeDto
      • CountryRefDto
      • CurrencyDto
      • CurrencyDtoPaginatedResponse
      • CurrencyDtoPaginatedResponseApiResponse
      • ExtraChargeDto
      • ExtraChargeDtoApiResponse
      • FeatureTypeDto
      • CurrencyRefDto
      • FeatureTypeDtoPaginatedResponse
      • FeatureTypeDtoPaginatedResponseApiResponse
      • GuestCreatedDto
      • GuestAddressDto
      • GuestCreatedDtoApiResponse
      • GuestLookupsDto
      • GuestLookupsDtoApiResponse
      • DepartureFiguresDto
      • GuestPhoneDto
      • GuestPreferencesDto
      • GuestProfileDtoApiResponse
      • GuestProfileDto
      • GuestReservationDtoPaginatedResponse
      • GuestReservationDtoPaginatedResponseApiResponse
      • GuestStaySummaryDto
      • GuestReservationDto
      • GuestProfileRequestDto
      • GuestSummaryItemDto
      • GuestSummaryItemDtoPaginatedResponse
      • GuestPassportDto
      • GuestSummaryItemDtoPaginatedResponseApiResponse
      • InventoryRoomTypeDto
      • InventorySnapshotDto
      • InventorySnapshotDtoPaginatedResponse
      • InventorySnapshotDtoPaginatedResponseApiResponse
      • LanguageRefDto
      • MasterRateBlockDto
      • MasterRateTypeDto
      • MasterRateTypeDtoPaginatedResponse
      • MasterRateTypeDtoPaginatedResponseApiResponse
      • LinkedGuestDto
      • MealPlanDto
      • ObjectApiResponse
      • PayMethodDto
      • PayMethodDtoPaginatedResponse
      • OtaReferenceDto
      • PayMethodDtoPaginatedResponseApiResponse
      • PaymentGatewayDto
      • PaymentGatewayDtoPaginatedResponse
      • PaymentGatewayDtoPaginatedResponseApiResponse
      • ProblemDetails
      • PosMenuItemDto
      • RateAdjustmentTemplateDto
      • PosMenuItemDtoPaginatedResponse
      • RateAdjustmentTemplateDtoPaginatedResponse
      • PosMenuItemDtoPaginatedResponseApiResponse
      • RateAdjustmentTemplateDtoPaginatedResponseApiResponse
      • RatePlanRefDto
      • RecentReservationsDto
      • ReservationBillingDto
      • ReservationCancellationDto
      • PropertyConfigurationDto
      • ReservationEventDtoPaginatedResponse
      • PropertyConfigurationDtoApiResponse
      • ReservationEventDtoPaginatedResponseApiResponse
      • ReservationSourceDto
      • ReservationStatusDto
      • ReservationDtoApiResponse
      • ReservationDtoListApiResponse
      • ReservationStatusDtoListApiResponse
      • ReservationDtoPaginatedResponse
      • ReservationStayStatusDto
      • ReservationDtoPaginatedResponseApiResponse
      • RoomAssignmentItemDto
      • ReservationBookingDto
      • RoomCheckInDto
      • RoomCheckOutDto
      • RoomDto
      • RoomDtoPaginatedResponse
      • RoomDtoPaginatedResponseApiResponse
      • ReservationEventDto
      • RoomInventoryUpdateRequestDto
      • RoomInventoryUpdateResponseDto
      • RoomInventoryUpdateResponseDtoApiResponse
      • RoomRateDto
      • ReservationDto
      • RoomRateDtoPaginatedResponse
      • RoomRateDtoPaginatedResponseApiResponse
      • ReservationRoomDto
      • RoomRateFailureDto
      • RoomRateItemDto
      • RoomRateUpdateRequestDto
      • RoomRateUpdateResponseDto
      • RoomRateUpdateResponseDtoApiResponse
      • ReservationGuestDto
      • RoomTypeDto
      • ReservationOccupancyDto
      • RoomTypeDtoPaginatedResponse
      • RoomTypeDtoPaginatedResponseApiResponse
      • RoomTypeRefDto
      • StaySpendDto
      • TemplateDateRangeDto
      • TitleRefDto
      • TravelAgentDto
      • RoomPerformanceComparisonDto
      • TravelAgentDtoPaginatedResponse
      • RoomPerformanceMetricsDto
      • TravelAgentDtoPaginatedResponseApiResponse
      • RoomPerformancePeriodDto
      • UpdateMasterRatesRequestDto
      • RoomPerformanceResponseDto
      • UpdateMasterRatesResultDto
      • RoomPerformanceResponseDtoApiResponse
      • UpdateMasterRatesResultDtoApiResponse
      • UpdateReservationRequestDto
      • UpdateReservationResponseDtoApiResponse
      • RoomTypePerformanceDto
      • UpdateReservationResponseDto
      • SpecialRequestsDto
  • MCP
    • Overview
    • Connect Your AI Assistant
  • Webhooks
    • Set Up and Edit Webhooks
    • Verify Webhook Signatures
    • List of Webhook Events
  1. Webhooks

List of Webhook Events

The events WinCloud will send, when each is sent, and the fields in its data.

Not live yet. These events are planned and are not sent today. Names and payloads can still change, so do not build against them until each one is announced in the Changelog.

Events#

Each event names the change, so you do not need to work out what happened from the record.
Events arrive in stages. The Available column shows which events the first release sends; those marked Later follow in later releases, each announced in the Changelog.

Reservations#

Event typeSent whenAvailable
reservation.createdA booking is made, on a channel, direct, as a walk-in or from a groupFirst release
reservation.modifiedAnything about the reservation changes: dates, room type, guest count, rate plan, guest name or statusFirst release
reservation.room_assignedA room is allocated before arrivalLater
reservation.checked_inThe guest arrivesLater
reservation.room_movedThe guest changes room during the stay, including an upgradeLater
reservation.stay_extendedThe guest adds nightsLater
reservation.stay_shortenedThe guest leaves earlyLater
reservation.checked_outThe guest departsLater
reservation.cancelledThe booking is cancelled, on a channel or at the propertyLater
reservation.no_showThe guest never arrived, found at night auditLater
reservation.expiredAn unconfirmed hold lapsesLater
Until the Later events are released, each of those changes arrives as 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.

Guests#

Event typeSent whenAvailable
guest.createdA guest profile is created, with a booking, at check-in or on its ownFirst release
guest.modifiedA guest's name, contact details, address, nationality, language or preferences changeFirst release

Rooms and rates#

Event typeSent whenAvailable
room.updatedA room's details changeLater
rate.updatedA rate, availability or restriction changes, including minimum stay, closed to arrival or departure, and stop-sellLater
The payloads for room and rate events will be published here before they go live.

POS menus#

Event typeSent whenAvailable
menu_item.createdA menu item is addedLater
menu_item.updatedA menu item changes, including being made inactiveLater
outlet_menu_item.createdAn item is added to an outlet's menuLater
outlet_menu_item.updatedAn outlet's menu item changes, including its price, or is made inactiveLater
Menu items are never deleted outright. An item taken off the menu arrives as an updated event with status set to Inactive.

Payloads#

Each example is the full request body WinCloud sends. Every event has the same outer fields, in the same order; only data differs by event type. The outer fields are described in Set Up and Edit Webhooks, and the tables below describe data.
Field names are camelCase. Times inside 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#

Every reservation event type, from 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.
Example: reservation.modified (check-in)
FieldDescription
reservationNoThe reservation's unique number. Use it to match events to a reservation
bookingNoThe booking number. Every reservation in a group booking shares it
onlineBookingRefNoThe booking reference from the online channel; null when not booked online
bookingBooking, arrival and departure dates and times, nights, rooms booked, currency, the booker's contactEmail and contactMobile, the deposit and the total room rate
partyNameThe company, agent or channel the booking is made under
occupancyAdults, children and total guests (pax)
roomType, ratePlanThe booked room type and rate plan, each with its code and name
reservedRoomThe room number allocated; null until a room is assigned
roomsOne 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
tariffThe nightly room rate
status.bookingStatusOne of Confirmed, WaitingList, Tentative, Provisional, CheckedIn, CheckedOut, Cancelled, NoShow, TurnAway or Unknown
status.cancellationnull unless cancelled; then cancellationNo, date, reason, requestedBy and cancelledBy
sourceThe channel (OTA, Direct, Corporate, TravelAgent or Unknown), business source, market segment and travel agent
specialRequestsThe guest's instructions, message and remarks
guestDetailsThe guests on the reservation, numbered by guestSno from 1. guestId matches the guestId in guest events
lastModifiedDateWhen the reservation was last changed
Amounts are in 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#

Event types guest.created and guest.modified. The guest's profile as it is after the change. The guest's bookings arrive as reservation events.
Example: guest.created
FieldDescription
guestIdThe guest's unique ID. It matches guestId in a reservation's guestDetails
titleThe guest's title, with its code and name
guestNameThe guest's name as stored in WinCloud
firstName, lastNameThe guest's first and last name
gender, dateOfBirthnull when not recorded
email, mobile, phoneThe guest's contact details
addressThe guest's address
nationality, countryOfResidenceEach with its WinCloud code, name and ISO 3166-1 alpha-3 isoCode
languageThe guest's language; null when not recorded
isPreferredGuesttrue for a preferred guest
preferencesLikes, dislikes, favourite room, hotel comment and preference notes
The guest payload has no last-changed time. If two guest.modified events for one guest arrive out of order, keep the one with the later createdAt.

Menu item#

Event types 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.
Example: menu_item.created
FieldDescription
companyIdThe company within the property
productId, productNameThe menu item
productGroupId, productGroupNameThe item's group, for example Food
productSubGroupId, productSubGroupNameThe item's sub-group
statusActive or Inactive, after the change
lastUpdatedWhen the item was last changed

Outlet menu item#

Event types outlet_menu_item.created and outlet_menu_item.updated. The item as it is sold at one outlet, with its price and tax.
Example: outlet_menu_item.updated
FieldDescription
companyId, outletIdThe company and the POS outlet
productId, productNameThe menu item
productGroupId, productGroupNameThe item's group, for example Food
productSubGroupId, productSubGroupNameThe item's sub-group
priceThe item's price at this outlet
taxStructureIdThe tax structure applied to the item
statusActive or Inactive, after the change
lastUpdatedWhen the item was last changed
Modified at 2026-11-11 09:20:52
Previous
Verify Webhook Signatures
Built with