Difference between revisions of "Setting/propertiesnotifyurl"
Markkinchin (talk | contribs) |
Markkinchin (talk | contribs) |
||
| (6 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | A push notification (webhook) will be sent to this URL when a new booking, significant booking modification which effects availability or cancellation occurs. | + | A push notification (webhook) will be sent to this URL when a new booking, significant booking modification which effects availability, a guest message from OTA or cancellation occurs. |
| + | |||
| + | Multiple URL's can be notified, enter each additional URL on a new line. | ||
| + | |||
| + | Your server should return an HTTP 200 header to acknowledge receipt of the notify. | ||
| + | |||
| + | If there is no response or a response HTTP code of 400 or higher the notify will be retried after a delay. | ||
| + | |||
| + | Outgoing messages are queued so there can be a short delay between the action occurring and the notification sending. | ||
| + | |||
| + | VERSION 2 webhooks will include a JSON object with the booking data in the format specified in API V2. | ||
| + | |||
| + | The following apples to VERSION 1 webhooks only: | ||
The bookid and status are appended to your url like this example. | The bookid and status are appended to your url like this example. | ||
| − | https://yoururl.com/yourpage?bookid=12345678&status=new | + | <code>https://yoururl.com/yourpage?bookid=12345678&status=new</code> |
Possible values for status are: new, modify, cancel, message | Possible values for status are: new, modify, cancel, message | ||
| − | The status modify could be sent for new or cancelled bookings if multiple fields are changed before the webhook sends, i.e. the first webhook may have status | + | The status modify could be sent for new or cancelled bookings if multiple fields are changed before the webhook sends, i.e. the first webhook you receive may have the status = modify instead of new and a cancelled booking may have a webhook with status = modify, do not use status = modify reported by a webhook to assume anything about the status of the booking. |
The card CVV and a token to retrieve it from the JSON getCard API function can be included as form url encoded POST data in the body of the push. | The card CVV and a token to retrieve it from the JSON getCard API function can be included as form url encoded POST data in the body of the push. | ||
| − | + | <span style="color: #f3e504; font-size: 150%;" >{{#fas:lightbulb}} </span> If you need to differentiate between multiple properties, an easy way is to include a property parameter in your URL | |
| − | + | <code>https://myserver.com/propid=1234 </code> | |
| − | + | The URL can contain template variables which will be exchanged with information from the booking. | |
| − | |||
| − | |||
| − | |||
| − | |||
The status values are not synchronous, it is possible the first notification will have status modified or cancel instead of new if the booking has changed to that state before the message sends. | The status values are not synchronous, it is possible the first notification will have status modified or cancel instead of new if the booking has changed to that state before the message sends. | ||
Latest revision as of 12:53, 8 July 2024
A push notification (webhook) will be sent to this URL when a new booking, significant booking modification which effects availability, a guest message from OTA or cancellation occurs.
Multiple URL's can be notified, enter each additional URL on a new line.
Your server should return an HTTP 200 header to acknowledge receipt of the notify.
If there is no response or a response HTTP code of 400 or higher the notify will be retried after a delay.
Outgoing messages are queued so there can be a short delay between the action occurring and the notification sending.
VERSION 2 webhooks will include a JSON object with the booking data in the format specified in API V2.
The following apples to VERSION 1 webhooks only:
The bookid and status are appended to your url like this example.
https://yoururl.com/yourpage?bookid=12345678&status=new
Possible values for status are: new, modify, cancel, message
The status modify could be sent for new or cancelled bookings if multiple fields are changed before the webhook sends, i.e. the first webhook you receive may have the status = modify instead of new and a cancelled booking may have a webhook with status = modify, do not use status = modify reported by a webhook to assume anything about the status of the booking.
The card CVV and a token to retrieve it from the JSON getCard API function can be included as form url encoded POST data in the body of the push.
If you need to differentiate between multiple properties, an easy way is to include a property parameter in your URL
https://myserver.com/propid=1234
The URL can contain template variables which will be exchanged with information from the booking.
The status values are not synchronous, it is possible the first notification will have status modified or cancel instead of new if the booking has changed to that state before the message sends.
