Last updated

Room Stay Change

Room Stay Change webhook triggers:

  • Room stay on a booking created
  • Room Stay on a booking updated

Summary

The follow table explains the fields

FieldDescription
typeThe type of webhook event. This indicates the nature of the data being sent, e.g., webhookRoomStayOutboundDto.
idUnique identifier for this webhook event (eb1ea7cc-66f7-42d8-94a6-492f438efdb7).
createdDateThe date and time the webhook was created, in array format (2024-11-28T07:54:47.898Z).
detailDtoContains detailed information about the room stay and associated bookings.
bookingsA list of bookings included in the webhook.
accountCodeThe account code for the booking (Dem15).
roomStayReferenceUnique reference for the room stay (20241128-00001/2).
hubSpotDealIdHubSpot Deal ID (null if not linked).
ratePlanThe rate plan applied to the booking (RACK RATE).
bookingStatusThe current status of the booking (CONFIRMED).
unitThe specific unit for the booking (Demo Property 1 1.1).
unitTypeThe type of unit being booked (Studio).
pmsStartDateStart date in the PMS (2024-11-28).
pmsEndDateEnd date in the PMS (2024-12-08).
startDateBooking start date (2024-11-28).
endDateBooking end date (2024-12-08).
nightsTotal number of nights for the stay (11).
guestStatusStatus of the guest (CONFIRMED).
guestAccountCodeAccount code associated with the guest (Dem15).
createdByName of the person who created the booking (Giles Horwitch-Smith).
dealOwnerOwner of the deal (null if not assigned).
buildingIdUnique identifier for the building (2).
buildingNameName of the building (Demo Property 1).
rate.originalNetMonthlyOriginal net monthly rate (150).
rate.originalRateTotalOriginal total rate for the stay (1500).
rate.discountRateMonthlyDiscounted rate per month (0).
rate.discountNetTotalDiscounted total amount (0).
typeType of event (GUEST_STATUS).
roomStayIdID of the room stay (2).
unitNameName of the unit (1.1).
unitIdUnique identifier for the unit (2).
unitAddressAddress details of the unit, including street, city, postcode, and country.
unitCustomFieldsCustom fields related to the unit (empty in this example).
floorSpaceFloor space of the unit (null in this example).
guestIdUnique identifier for the guest (2).
guestFirstNameFirst name of the guest (Demo).
guestLastNameLast name of the guest (Booker).
guestEmailAddressEmail address of the guest (demobooker@resharmonics.com).
guestTelephoneNumberTelephone number of the guest (0121 295 1310).
contactIdUnique identifier for the contact (2).
bookingAccountNameName of the booking account (Demo Booker).
bookingAccountIdID of the booking account (15).
identifierUnique identifier for this specific booking event (3a3b3cb4-d92f-414b-ab17-5ecf02569713).

Example

{
   "type":"webhookRoomStayOutboundDto",
   "id":"eb1ea7cc-66f7-42d8-94a6-492f438efdb7",
   "createdDate":[
      2024,
      11,
      28,
      7,
      54,
      47,
      898000000
   ],
   "detailDto":{
      "bookings":[
         {
            "accountCode":"Dem15",
            "roomStayReference":"20241128-00001/2",
            "hubSpotDealId":null,
            "ratePlan":"RACK RATE",
            "bookingStatus":"CONFIRMED",
            "unit":"Demo Property 1 1.1",
            "unitType":"Studio",
            "pmsStartDate":"2024-11-28",
            "pmsEndDate":"2024-12-08",
            "startDate":"2024-11-28",
            "endDate":"2024-12-08",
            "nights":11,
            "guestStatus":"CONFIRMED",
            "guestAccountCode":"Dem15",
            "createdBy":"Giles Horwitch-Smith",
            "dealOwner":null,
            "buildingId":2,
            "previousBuildingId":2,
            "buildingName":"Demo Property 1",
            "rate":{
               "originalNetMonthly":150,
               "originalRateTotal":1500,
               "discountRateMonthly":0,
               "discountNetTotal":0
            },
            "type":"GUEST_STATUS",
            "roomStayId":2,
            "unitName":"1.1",
            "unitId":2,
            "previousUnitId":2,
            "unitAddress":{
               "addressLine1":"Demo Street.",
               "addressLine2":null,
               "addressLine3":null,
               "city":"London",
               "postcode":"EC4A 1ED",
               "country":"United Kingdom",
               "isoCountry2":"GB",
               "nickname":null
            },
            "unitCustomFields":[
            ],
            "floorSpace":null,
            "guestId":2,
            "guestFirstName":"Demo",
            "guestLastName":"Booker",
            "guestEmailAddress":"demobooker@resharmonics.com",
            "guestTelephoneNumber":"0121 295 1310",
            "contactId":2,
            "bookingAccountName":"Demo Booker",
            "bookingAccountId":15,
            "identifier":"3a3b3cb4-d92f-414b-ab17-5ecf02569713"
         }
      ]
   }
}