Adding a webhook or callback URL gives the hotel the possibility of receiving booking details in JSON format through a URL.
A webhook sends out a callback to a given URL and is triggered each time a booking is created, modified or canceled.
The webhook/callback feature is triggered from:
- The Sirvoy Booking Engine
- The Review booking form
- Sales Channel bookings
It can be activated in Settings -> Your account -> Callback URL.
The receiving server has to respond with response code 200 OK, otherwise the call will be retried every 30 minutes up to 10 times. We only support HTTPS using TLS version 1.2 and up to ensure privacy and confidentiality. The HTTPS certificate also needs to be valid, otherwise no data will be sent. The booking data is sent as a POST with the JSON as the request body.
Please also make sure your server will respond to a HTTP GET request with 200 OK. This is used as a health check that is called every now and then to make sure your endpoint is active. But no data will ever be pushed to you using a HTTP GET.
Callbacks will be made from the below IP-ranges. If you want to restrict traffic to your server, all of the below ranges need to be permitted in your firewall:
- 34.243.166.60
- 52.18.11.99
- 63.34.80.48
- 54.194.0.85
- 2a05:d018:e34:5300::/56
The servers making the callbacks are dual-stack having both ipv4 and ipv6 connectivity. If you add both ipv4 and ipv6 addresses to your domain name the callback will be made to the server that is the first to respond.
Below are some examples of the JSON format generated data when a new booking is created:
{
"version":"1.0",
"callbackId":2464764,
"generatedTime":"2021-09-08T11:41:06+00:00",
"event":"new",
"propertyId":1,
"bookingId":26006,
"channelBookingId":null,
"bookingDate":"2021-09-08T11:37:42+00:00",
"arrivalDate":"2021-09-08",
"departureDate":"2021-09-10",
"cancelled":false,
"eta":null,
"totalAdults":2,
"guest":{
"firstName":"John",
"lastName":"Doe",
"businessName":"Acme Corporation",
"address":"123 Main St",
"postcode":"17101",
"city":"AnyTown",
"state":"DE",
"country":"US",
"phone":"+17184547453",
"email":"john.doe@mailservice.us",
"passportNo":null,
"language":"en",
"message":"Your hotel looks nice :)"
},
"guestReference":null,
"internalComment":null,
"couponCode":null,
"bookingSource":"Front desk",
"bookingIsProvisional":false,
"bookingProvisionalId":null,
"bookingIsCheckedIn":false,
"bookingIsCheckedOut":false,
"customFields":[
{
"name":"Custom field",
"value":"custom field text filled by guest"
},
{
"name":"Checkbox",
"value":true
},
{
"name":"new checkbox",
"value":false
}
],
"rooms":[
{
"RoomTypeName":"Basic room",
"RoomTypeDescription":"As basic as it gets, with a small window included.",
"RoomName":"110",
"arrivalDate":"2021-09-08",
"departureDate":"2021-09-10",
"adults":2,
"quantity":2,
"price":100,
"roomTotal":200,
"guestName":null,
"comment":null,
"ledgerAccount":null
}
],
"additionalItems":[
{
"description":"Cleaning Fee",
"specificDate":null,
"quantity":1,
"price":0,
"itemTotal":0,
"ledgerAccount":null
}
],
"bookedCategory":null,
"currency":"EUR",
"totalPrice":200,
"totalSurcharges":20,
"totalPriceIncludingSurcharges":220,
"payments":[
],
"invoices":[
]
}
This is how it can look after a cash receipt is created and a payment is moved to an invoice – payments and invoices this booking has is also included in the callback. Any other change also results in a callback with the data how the booking looks now:
{
"version":"1.0",
"callbackId":2464765,
"generatedTime":"2021-09-08T11:45:01+00:00",
"event":"modified",
"propertyId":1,
"bookingId":26006,
"channelBookingId":null,
"bookingDate":"2021-09-08T11:37:42+00:00",
"arrivalDate":"2021-09-08",
"departureDate":"2021-09-10",
"cancelled":false,
"eta":null,
"totalAdults":2,
"guest":{
"firstName":"John",
"lastName":"Doe",
"businessName":"Acme Corporation",
"address":"123 Main St",
"postcode":"17101",
"city":"AnyTown",
"state":"DE",
"country":"US",
"phone":"+17184547453",
"email":"john.doe@mailservice.us",
"passportNo":null,
"language":"en",
"message":"Your hotel looks nice :)"
},
"guestReference":null,
"internalComment":null,
"couponCode":null,
"bookingSource":"Front desk",
"bookingIsProvisional":false,
"bookingProvisionalId":null,
"bookingIsCheckedIn":false,
"bookingIsCheckedOut":false,
"customFields":[
{
"name":"Custom field",
"value":"custom field text filled by guest"
},
{
"name":"Checkbox",
"value":true
},
{
"name":"new checkbox",
"value":false
}
],
"rooms":[
{
"RoomTypeName":"Basic room",
"RoomTypeDescription":"As basic as it gets, with a small window included.",
"RoomName":"110",
"arrivalDate":"2021-09-08",
"departureDate":"2021-09-10",
"adults":2,
"quantity":2,
"price":100,
"roomTotal":200,
"guestName":null,
"comment":null,
"ledgerAccount":null
}
],
"additionalItems":[
{
"description":"Cleaning Fee",
"specificDate":null,
"quantity":1,
"price":0,
"itemTotal":0,
"ledgerAccount":null
}
],
"bookedCategory":null,
"currency":"EUR",
"totalPrice":200,
"totalSurcharges":20,
"totalPriceIncludingSurcharges":220,
"payments":[
],
"invoices":[
{
"invoiceNumber":"41001",
"invoiceDate":"2021-09-08",
"dueDate":"2021-09-08",
"receiver":"Acme Corporation",
"address":[
"John Doe",
"123 Main St",
"AnyTown, DE 17101",
"United States"
],
"roundingAmount":0,
"invoiceTotal":220,
"originInvoice":null,
"invoiceRows":[
{
"quantity":2,
"price":100,
"rowTotal":200,
"ledgerAccount":"3010",
"rowText":"Basic room",
"vatRate":0,
"vatAmount":0
},
{
"quantity":1,
"price":20,
"rowTotal":20,
"ledgerAccount":"sur1",
"rowText":"10",
"vatRate":0,
"vatAmount":0
}
],
"payments":[
{
"amount":220,
"ledgerAccount":"",
"paymentReference":null,
"comment":""
}
]
}
]
}