Webhook Data Points per Event

This document describes the valid data points available for each webhook event type in Open API.

Event Types and Their Data Points

reservationCreated

Description: Reservation created

Available Data Points:

• apartmentNumber
• durationOfStay
• earliestCheckInTime
• endDate
• estimatedCheckInTime
• estimatedCheckOutTime
• externalId
• externalPropertyId
• fullPrice
• guestAppLink
• guestCountry
• guestProfiles
• guestsInfo
• lastName
• latestCheckOutTime
• numberOfGuests
• preCheckInLink
• preCheckOutLink
• reservationId
• sId
• startDate
• timestamp
• verifiedEmail
• verifiedFirstName
• verifiedLastName
• verifiedPhone

updateReservationStatus

Description: Reservation status updated

Available Data Points:

• apartmentNumber
• bookingStatus
• company
• companyName
• currentStatus
• durationOfStay
• earliestCheckInTime
• endDate
• estimatedCheckInTime
• estimatedCheckOutTime
• externalId
• externalPropertyId
• guestCountry
• guestProfiles
• guestsInfo
• lastName
• latestCheckOutTime
• numberOfGuests
• pmsExternalId
• reservationId
• source
• startDate
• statusToUpdate
• timestamp
• verifiedEmail
• verifiedFirstName
• verifiedLastName
• verifiedPhone

preCheckInStarted

Description: Pre Check-in started

Available Data Points:

• airportLanding
• allowOptInMarketing
• arrivalMethod
• checkInOption
• clientExternalId
• company
• creditCardUploaded
• customFieldsAnswers
• earliestCheckInTime
• endDate
• estimatedCheckInDateTime
• estimatedCheckInTime
• externalId
• externalPropertyId
• flightNumber
• flightOrigin
• galleryLink
• guestCategoryCode
• guestCountry
• guestProfiles
• guestsInfo
• humanReadable
• isQuickAction
• landingTime
• latestCheckOutTime
• membershipIndication
• membershipType
• needTransport
• origin
• paidForStay
• passportUploaded
• platformReferral
• pmsExternalId
• preferredLanguage
• reservationId
• reservationLink
• signDocumentName
• skipStayPaymentStep
• skippedSignedDocument
• source
• startDate
• timestamp
• trainStation
• tz
• verifiedAdults
• verifiedBabies
• verifiedChildren
• verifiedEmail
• verifiedFirstName
• verifiedLastName
• verifiedPhone

preCheckInUpdated

Description: Pre Check-in updated

Available Data Points: Same as preCheckInStarted

preCheckInDone

Description: Pre Check-in completed

Available Data Points: Same as preCheckInStarted plus:

• prefix

preCheckOutUpdated

Description: Pre Check-out updated

Available Data Points:

• allowOptInMarketing
• apartmentNumber
• bookingStatus
• checkOutReview
• checkOutScore
• clientExternalId
• company
• creditCardUploaded
• durationOfStay
• endDate
• estimatedCheckOutDateTime
• estimatedCheckOutTime
• externalId
• externalPropertyId
• guestCountry
• guestProfiles
• guestsInfo
• humanReadable
• lastName
• latestCheckOutTime
• needTransport
• numberOfGuests
• paidForStay
• pmsExternalId
• propertyIssues
• reservationId
• reservationLink
• skipStayPaymentStep
• source
• startDate
• timestamp
• verifiedAdults
• verifiedBabies
• verifiedChildren
• verifiedEmail
• verifiedFirstName
• verifiedLastName
• verifiedPhone

preCheckOutDone

Description: Pre Check-out completed

Available Data Points: Same as preCheckOutUpdated

pendingOrderCreated

Description: Pending order created

Available Data Points:

• allowOptInMarketing
• amountDue
• apartmentNumber
• bookingStatus
• clientExternalId
• companyData
• creditCardUploaded
• durationOfStay
• endDate
• externalId
• externalPropertyApiKey
• externalPropertyId
• extraCharges
• firstName
• groupMemberExternalId
• guestCountry
• guestExternalId
• guestProfiles
• guestsInfo
• hostFullAddress
• humanReadable
• humanReadableComment
• isChild
• isParent
• itemExternalId
• lastName
• link
• numberOfGuests
• orderDetails
• paidReservations
• productDetails
• refundedAmount
• refundPercentage
• reservationId
• source
• specialRequests
• startDate
• timestamp
• verifiedEmail
• verifiedFirstName
• verifiedLastName
• verifiedPhone

orderCreated

Description: Order created

Available Data Points: Same as pendingOrderCreated plus:

• daysBeforeCheckin
• platformReferral
• appReferral

orderCancelled

Description: Order cancelled

Available Data Points: Same as pendingOrderCreated

orderRefunded

Description: Order refunded

Available Data Points: Same as pendingOrderCreated

orderDenied

Description: Host denied the order

Available Data Points: Same as pendingOrderCreated

orderExpired

Description: Order request has expired

Available Data Points: Same as pendingOrderCreated

guestDocumentUploaded

Description: Guest document uploaded

Available Data Points:

• clientExternalId
• company
• companyName
• documents
• durationOfStay
• externalId
• externalPropertyId
• guestCountry
• guestProfiles
• guestsInfo
• lastName
• link
• numberOfGuests
• reservationId
• source
• timestamp
• uploadedDocsEmailSentIndex
• verifiedEmail
• verifiedFirstName
• verifiedLastName
• verifiedPhone

guestFullDocumentUploaded

Description: Guest full document uploaded

Available Data Points: Same as guestDocumentUploaded

guestLinkOpenedGuestApp

Description: Guest link opened Guest app

Available Data Points:

• bookingStatus
• clientExternalId
• currentStatus
• durationOfStay
• endDate
• estimatedCheckInDateTime
• estimatedCheckOutDateTime
• externalId
• guestCountry
• guestLink
• guestProfiles
• guestsInfo
• lastName
• membershipIndication
• membershipType
• numberOfGuests
• reservationId
• startDate
• timestamp
• verifiedEmail
• verifiedFirstName
• verifiedLastName
• verifiedPhone

guestLinkOpenedCheckIn

Description: Guest link opened Online Check-in

Available Data Points: Same as guestLinkOpenedGuestApp

guestLinkOpenedCheckOut

Description: Guest link opened Online Check-out

Available Data Points: Same as guestLinkOpenedGuestApp

messageSent

Description: Message sent

Available Data Points:

• apartmentNumber
• author
• chatId
• clientExternalId
• crsExternalId
• externalId
• floor
• guestChatLink
• messageContent
• pmsExternalId
• preferredLanguage
• reservationId
• sentAt
• sentVia
• timestamp
• verifiedEmail
• verifiedPhone

reservationRoomAssign

Description: Reservation room assigned

Available Data Points:

• apartmentNumber
• bookingStatus
• clientExternalId
• company
• companyName
• currentStatus
• earliestCheckInTime
• endDate
• estimatedCheckInTime
• estimatedCheckOutTime
• externalId
• externalPropertyId
• guestAppLink
• latestCheckOutTime
• pmsExternalId
• preCheckInLink
• reservationId
• sId
• source
• startDate
• statusToUpdate
• timestamp

reservationDetailsUpdated

Description: ETA, ETD, or stay dates updated

Available Data Points:

• apartmentNumber
• bookingStatus
• company
• companyName
• currentStatus
• earliestCheckInTime
• endDate
• estimatedCheckInTime
• estimatedCheckOutTime
• externalId
• guestAppLink
• latestCheckOutTime
• pmsExternalId
• preCheckInLink
• preCheckOutLink
• reservationId
• sId
• startDate
• timestamp

basicMarketingStatusUpdated

Description: Basic marketing status updated

Available Data Points:

• apartmentNumber
• basicMarketingConsent
• company
• currentStatus
• endDate
• externalId
• firstName
• lastName
• reservationId
• startDate
• timestamp
• verifiedEmail
• verifiedPhone

externalMarketingStatusUpdated

Description: External marketing status updated

Available Data Points:

• bookingStatus
• company
• companyName
• currentStatus
• endDate
• externalId
• externalMarketingConsent
• firstName
• lastName
• reservationId
• startDate
• timestamp
• verifiedEmail
• verifiedPhone