Webhook data points
Below are the supported webhook data points. Include any of these keys in the dataPoints
array of your webhook configuration to enrich the delivered payload.
Key | Description |
---|---|
id | Reservation id |
sId | Short id used in guest links |
externalId | PMS reservation id |
preCheckInLink | Link to pre check-in |
preCheckOutLink | Link to pre check-out |
guestAppLink | Link to guest app |
pmsExternalId | PMS account id (if applicable) |
src | Source label |
company | Company id |
companyName | Company name |
currentStatus | Current status |
bookingStatus | Booking status |
statusToUpdate | Status to update |
estimatedCheckInTime | Estimated check-in time |
earliestCheckInTime | Earliest check-in time |
reservationLink | Link to reservation in Console |
humanReadable | Human-readable summary |
isQuickAction | Whether triggered by quick action |
clientExternalId | Client external id |
externalPropertyId | External property id |
guestCategoryCode | Guest category code |
tz | Timezone |
customFieldsAnswers | Custom field answers |
estimatedCheckInDateTime | Estimated check-in date time |
verifiedAdults | Verified adults count |
verifiedChildren | Verified children count |
verifiedBabies | Verified babies count |
verifiedEmail | Verified email |
verifiedPhone | Verified phone |
verifiedFirstName | Verified first name |
verifiedLastName | Verified last name |
creditCardUploaded | Credit card uploaded |
passportUploaded | Passport uploaded |
arrivalMethod | Arrival method |
flightOrigin | Flight origin |
flightNumber | Flight number |
airportLanding | Airport landing |
trainNumber | Train number |
origin | Origin |
trainStation | Train station |
landingTime | Landing time |
needTransport | Need transport |
allowOptInMarketing | Allow opt-in marketing |
checkInOption | Check-in option |
paidForStay | Paid for stay |
skipStayPaymentStep | Skip stay payment step |
skipedSignedDocument | Skipped signed document |
signDocumentName | Sign document name |
galleryLink | Gallery link |
preferredLanguage | Preferred language |
guestCountry | Guest country |
guestsInfo | Guests info |
guestProfiles | Guest profiles |
checkOutScore | Check out score |
checkOutReview | Check out review |
propertyIssues | Property issues |
estimatedCheckOutTime | Estimated check-out time |
estimatedCheckOutDateTime | Estimated check-out date time |
latestCheckOutTime | Latest check-out time |
startDate | Start date |
endDate | End date |
firstName | First name |
lastName | Last name |
extraCharges | Extra charges |
guestExternalId | Guest external id |
groupMemberExternalId | Group member external id |
paidReservations | Paid reservations |
link | Link |
order | Order details |
product | Product details |
refundedAmount | Refunded amount |
refundPercentage | Refund percentage |
isParent | Is parent reservation |
isChild | Is child reservation |
externalPropertyApiKey | External property API key |
humanReadableComment | Human readable comment |
documents | Documents |
uploadedDocsEmailSentIndex | Uploaded docs email sent index |
guestLink | Guest link |
apartmentNumber | Apartment number |
durationOfStay | Duration of stay |
numberOfGuests | Number of guests |
cq-{{cqfId}} | Custom question key |
amountDue | Amount due |
specialRequests | Special requests |
hostFullAddress | Host full address |
messageContent | Message content |
author | Message author |
sentAt | Sent at |
sentVia | Sent via |
guestChatLink | Guest chat link |
chatId | Chat id |
crsExternalId | CRS guest external id |
fullPrice | Full price |
prefix | Prefix |
externalMarketingConsent | External marketing consent |
basicMarketingConsent | Basic marketing consent |
floor | Floor |
order.bookingDetails.selectedVariables.externalId | Order item external id (Menu product) |