Webhooks: Listings
Webhook notifications for changes to listings.
Guesty's Open API allows you to send various listing-related notifications to your application's notification URL(s).
What Notifications Can I Receive?
Listing notifications are sent by Guesty when there are changes to any of a listings settings and content.
Why Create a Listing Updates Webhook?
Once your Guesty Open API integration is complete and finished with its initial synchronization of data, we recommend you to utilize the listing webhook notification. Webhook notifications will help you save time and resources. Plus, you get to only synchronize the listing data that has changed and ignore that which has remained in the same state since the initial synchronization.
New Listing Notification
This webhook is sent upon the creation of a new listing. Learn how to create this webhook here.
Notification Payload
| Body Parameter | Data Type | Description |
|---|---|---|
listing | object | The new listings object. |
event | string | listing.new |
New Listing Notification Payload Example
{
"listing": {
"SaaS": {
"autoRenew": true
},
"cleaningStatus": {
"value": null
},
"picture": {
"thumbnail": "https://res.cloudinary.com/guesty/image/upload/c_fit,h_200/v1674637062/production/62a8a2be2e53190032102a6e/fxx2t41egu6f06but9qf.jpg"
},
"terms": {
"minNights": 5,
"maxNights": 45
},
"prices": {
"monthlyPriceFactor": 1,
"weeklyPriceFactor": 1,
"currency": "EUR",
"basePrice": 1326
},
"pms": {
"automation": {
"answeringMachine": {
"confirmedBeforeCheckIn": {
"delayInMinutes": 45
},
"confirmedDayOfCheckIn": {
"delayInMinutes": 45
},
"confirmedDayOfCheckOut": {
"delayInMinutes": 45
},
"confirmedDuringStay": {
"delayInMinutes": 45
},
"confirmedAfterCheckOut": {
"delayInMinutes": 45
},
"unconfirmedFirstMessage": {
"delayInMinutes": 55
},
"unconfirmedSubsequentMessage": {
"delayInMinutes": 45
}
},
"hooks": {
"ignoredHooks": []
},
"calendarSmartRules": {
"blockListings": []
},
"autoReviews": {
"templates": []
},
"autoPricing": {
"rules": []
}
},
"tasks": {
"defaultTasks": []
},
"autoPayments": {
"policy": []
},
"active": true,
"cleaningStatus": {
"active": true
}
},
"sales": {
"salesService": {
"atPhones": []
}
},
"receptionistsService": {
"receptionDesk": {
"atPhones": [],
"ittt": []
},
"screening": {
"checklist": []
}
},
"calendarRules": {
"defaultAvailability": "AVAILABLE",
"advanceNotice": {
"bookingCom": {
"isCutOffHoursEnabled": false
},
"expedia": {
"isCutOffHoursEnabled": false
},
"airbnb2": {
"isCutOffHoursEnabled": true
},
"directBookings": {
"isCutOffHoursEnabled": false
},
"updatedAt": "2023-01-25T09:00:54.951Z"
},
"bookingWindow": {
"updatedAt": "2023-01-25T09:00:54.951Z"
},
"preparationTime": {
"updatedAt": "2023-01-25T09:00:54.951Z"
},
"defaultAvailabilityUpdatedAt": "2023-01-25T09:00:54.953Z",
"rentalPeriods": []
},
"type": "SINGLE",
"tags": [
"RML"
],
"owners": [],
"amenities": [
"BBQ grill",
"Cable TV",
"Dishwasher",
"Elevator",
"Free parking on premises",
"Dryer",
"Heating",
"Indoor fireplace",
"Iron",
"Refrigerator",
"Stove",
"TV",
"Washer",
"Air conditioning",
"Accessible-height bed",
"Accessible-height toilet",
"Beach",
"Beach essentials",
"Beach Front",
"Beach View",
"Bed linens",
"Bicycles available",
"Carbon monoxide detector",
"Cleaning before checkout",
"Cleaning Disinfection",
"Coffee maker",
"Cookware",
"Desk",
"Dishes and silverware",
"Doorman",
"Emergency exit",
"Enhanced cleaning practices",
"EV charger",
"Essentials",
"Extra pillows and blankets",
"Fire extinguisher",
"Fireplace guards",
"First aid kit",
"Garden or backyard",
"Gym",
"Grab-rails for shower and toilet",
"Hangers",
"Hair dryer",
"High touch surfaces disinfected",
"Hot tub",
"Hot water",
"Indoor pool",
"Internet",
"Kettle",
"Wireless Internet",
"Wide clearance to shower and toilet",
"Wide clearance to bed",
"Wheelchair accessible",
"Waterfront",
"Water View",
"Towels provided",
"Toaster",
"Sea view",
"Smoke detector",
"Shampoo",
"Patio or balcony",
"Outdoor pool",
"Near Ocean",
"Oven",
"Microwave",
"Laptop friendly workspace",
"Kitchen"
],
"amenitiesNotIncluded": [],
"useAccountRevenueShare": true,
"netIncomeFormula": "host_payout",
"commissionFormula": "net_income",
"ownerRevenueFormula": "net_income - pm_commission",
"useAccountAdditionalFees": true,
"useAccountTaxes": true,
"useAccountMarkups": true,
"active": true,
"preBooking": [],
"_id": "63d0efc68da76c004be34446",
"accommodates": 30,
"bathrooms": 10,
"defaultCheckInTime": "15:00",
"defaultCheckOutTime": "10:00",
"propertyType": "Castle",
"roomType": "Entire home/apt",
"address": {
"full": "Eliezer Kaplan St 2, Tel Aviv-Yafo, Israel",
"lng": 34.78202479999999,
"lat": 32.0733456,
"street": "Eliezer Kaplan Street 2",
"city": "Tel Aviv-Yafo",
"country": "Israel",
"state": "Tel Aviv District"
},
"pictures": [
{
"_id": "63d0efc68da76c004be3444f",
"original": "https://res.cloudinary.com/guesty/image/upload/v1674637062/production/62a8a2be2e53190032102a6e/fxx2t41egu6f06but9qf.jpg",
"thumbnail": "https://res.cloudinary.com/guesty/image/upload/c_fit,h_200/v1674637062/production/62a8a2be2e53190032102a6e/fxx2t41egu6f06but9qf.jpg",
"height": 1280,
"width": 1920,
"size": 120311
},
{
"_id": "63d0efc68da76c004be3444e",
"original": "https://res.cloudinary.com/guesty/image/upload/v1674637062/production/62a8a2be2e53190032102a6e/qgl6w6szkgpsnlwg9eyq.jpg",
"thumbnail": "https://res.cloudinary.com/guesty/image/upload/c_fit,h_200/v1674637062/production/62a8a2be2e53190032102a6e/qgl6w6szkgpsnlwg9eyq.jpg",
"height": 1080,
"width": 1920,
"size": 381481
},
{
"_id": "63d0efc68da76c004be3444d",
"original": "https://res.cloudinary.com/guesty/image/upload/v1674637062/production/62a8a2be2e53190032102a6e/fqbd1ib9vuhtlkwmint1.jpg",
"thumbnail": "https://res.cloudinary.com/guesty/image/upload/c_fit,h_200/v1674637062/production/62a8a2be2e53190032102a6e/fqbd1ib9vuhtlkwmint1.jpg",
"height": 1080,
"width": 1920,
"size": 259342
},
{
"_id": "63d0efc68da76c004be3444c",
"original": "https://res.cloudinary.com/guesty/image/upload/v1674637062/production/62a8a2be2e53190032102a6e/p8fwoiieitpoigvh9hlf.jpg",
"thumbnail": "https://res.cloudinary.com/guesty/image/upload/c_fit,h_200/v1674637062/production/62a8a2be2e53190032102a6e/p8fwoiieitpoigvh9hlf.jpg",
"height": 2000,
"width": 3000,
"size": 634687
},
{
"_id": "63d0efc68da76c004be3444b",
"original": "https://res.cloudinary.com/guesty/image/upload/v1674637062/production/62a8a2be2e53190032102a6e/sy91hcxugsgz32ykzdjz.jpg",
"thumbnail": "https://res.cloudinary.com/guesty/image/upload/c_fit,h_200/v1674637062/production/62a8a2be2e53190032102a6e/sy91hcxugsgz32ykzdjz.jpg",
"height": 1274,
"width": 1920,
"size": 317755
},
{
"_id": "63d0efc68da76c004be3444a",
"original": "https://res.cloudinary.com/guesty/image/upload/v1674637062/production/62a8a2be2e53190032102a6e/q64hxw9p07dc6uionraw.jpg",
"thumbnail": "https://res.cloudinary.com/guesty/image/upload/c_fit,h_200/v1674637062/production/62a8a2be2e53190032102a6e/q64hxw9p07dc6uionraw.jpg",
"height": 1280,
"width": 1920,
"size": 279615
},
{
"_id": "63d0efc68da76c004be34449",
"original": "https://res.cloudinary.com/guesty/image/upload/v1674637064/production/62a8a2be2e53190032102a6e/fc9ljmbclhnd9dzs8blt.jpg",
"thumbnail": "https://res.cloudinary.com/guesty/image/upload/c_fit,h_200/v1674637064/production/62a8a2be2e53190032102a6e/fc9ljmbclhnd9dzs8blt.jpg",
"height": 1080,
"width": 1920,
"size": 446442
},
{
"_id": "63d0efc68da76c004be34448",
"original": "https://res.cloudinary.com/guesty/image/upload/v1674637064/production/62a8a2be2e53190032102a6e/owhvwc9smsustm0ksswe.jpg",
"thumbnail": "https://res.cloudinary.com/guesty/image/upload/c_fit,h_200/v1674637064/production/62a8a2be2e53190032102a6e/owhvwc9smsustm0ksswe.jpg",
"height": 2001,
"width": 3000,
"size": 550247
},
{
"_id": "63d0efc68da76c004be34447",
"original": "https://res.cloudinary.com/guesty/image/upload/v1674637064/production/62a8a2be2e53190032102a6e/wh6of6jcdywtaufvlhgt.jpg",
"thumbnail": "https://res.cloudinary.com/guesty/image/upload/c_fit,h_200/v1674637064/production/62a8a2be2e53190032102a6e/wh6of6jcdywtaufvlhgt.jpg",
"height": 2001,
"width": 3000,
"size": 431561
}
],
"nickname": "Aventador Castle",
"title": "Aventador Castle",
"accountId": "62a8a2be2e53190032102a6e",
"isListed": false,
"timezone": "Asia/Jerusalem",
"createdAt": "2023-01-25T09:00:54.952Z",
"lastUpdatedAt": "2023-01-25T09:00:54.991Z",
"plan": [
{
"_id": "63d0efc68da76c004be34450",
"name": "SOFTWARE",
"planType": "RESERVATION_COMMISSION",
"isLocked": true,
"id": "63d0efc68da76c004be34450"
},
{
"_id": "63d0efc68da76c004be34451",
"name": "RECEPTIONISTS_SERVICE",
"planType": "RESERVATION_COMMISSION",
"isLocked": true,
"id": "63d0efc68da76c004be34451"
},
{
"_id": "63d0efc68da76c004be34452",
"name": "RENTALS_UNITED",
"planType": "RESERVATION_COMMISSION",
"isLocked": true,
"id": "63d0efc68da76c004be34452"
},
{
"_id": "63d0efc68da76c004be34453",
"name": "AIRBNB",
"planType": "RESERVATION_COMMISSION",
"isLocked": true,
"id": "63d0efc68da76c004be34453"
},
{
"_id": "63d0efc68da76c004be34454",
"name": "PAYMENT_PLATFORM_FEE",
"planType": "TRANSACTION_COMMISSION",
"isLocked": true,
"id": "63d0efc68da76c004be34454"
}
],
"integrations": [],
"pendingTasks": [],
"listingRooms": [],
"taxes": [],
"customFields": [],
"offeredServices": [],
"importedAt": "2023-01-25T09:00:54.953Z",
"occupancyStats": [],
"__v": 0,
"id": "63d0efc68da76c004be34446"
},
"event": "listing.new"
}
Listing Updated Notification
This webhook notification is sent whenever a change is made to a listing's settings or content within your Guesty account. Learn how to create this webhook here.
Notification Payload
| Body Parameter | Data Type | Description |
|---|---|---|
listing | object | The updated listing object. |
event | string | listing.updated |
Listing Updated Notification Payload Example
{
"listing": {
"_id": "62a98853d11e6b00354c3b8b",
"picture": {
"thumbnail": "https://res.cloudinary.com/guesty/image/upload/c_fit,h_200/v1655270701/production/563e0b6a08a2710e00057b82/fucrcqvzfmuotrfyut3e.jpg"
},
"prices": {
"weeklyPriceFactor": 1,
"currency": "PHP",
"basePrice": 3000,
"monthlyPriceFactor": 1
},
"pms": {
"automation": {
"hooks": {
"ignoredHooks": []
}
},
"tasks": {
"defaultTasks": []
}
},
"calendarRules": {
"defaultAvailability": "AVAILABLE",
"rentalPeriods": [],
"advanceNotice": {
"airbnb2": {
"isCutOffHoursEnabled": true
}
}
},
"type": "MTL",
"tags": [],
"owners": [],
"amenities": [
"Air conditioning",
"BBQ grill",
"Baby bath",
"Bathtub",
"Beach essentials",
"Beach Front",
"Beach View",
"Children’s dinnerware",
"Changing table",
"Bicycles available",
"Cleaning Disinfection",
"Coffee maker",
"Air conditioning",
"BBQ grill",
"Baby bath",
"Bathtub",
"Beach essentials",
"Beach Front",
"Beach View",
"Children’s dinnerware",
"Changing table",
"Bicycles available",
"Cleaning Disinfection",
"Coffee maker"
],
"active": true,
"accommodates": 2,
"bathrooms": 1,
"propertyType": "Boat",
"roomType": "Entire home/apt",
"address": {
"full": "1892 W 5th St, Austin, TX 78701, USA",
"lng": -97.74332179999999,
"lat": 30.26731,
"street": "West 5th Street 1892",
"city": "Austin",
"country": "United States",
"zipcode": "78701",
"state": "Texas"
},
"bedrooms": 1,
"beds": 1,
"timezone": "America/Chicago",
"nickname": "Paul Private Resort",
"title": "Paul Private Resort",
"accountId": "563e0b6a08a2710e00057b82",
"isListed": false,
"yieldManagement": {
"rateStrategy": {
"_id": "62a96e032ade680034d28c08",
"name": "Paul Test"
}
},
"mtl": {
"c": [
"62a98853d11e6b00354c3c8d",
"62a98853d11e6b00354c3c96",
"62a96d617c541700310be4c1"
],
"hdb4": 14,
"_id": "62a98853d11e6b00354c3b8f",
"aas": "oc",
"bc": null
},
"integrations": []
},
"event": "listing.updated"
}
Updated 8 months ago
What’s Next