Setting/propertiesnotifyurl - Revision history

Markkinchin at 11:53, 8 July 2024

2024-07-08T11:53:00Z

@@ Line 1: / Line 1: @@
 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.
 The bookid and status are appended to your url like this example.
@@ Line 16: / Line 28: @@
 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.

Annette at 09:39, 15 December 2023

2023-12-15T09:39:37Z

← Older revision		Revision as of 09:39, 15 December 2023
Line 3:		Line 3:
	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

Annette at 09:39, 15 December 2023

2023-12-15T09:39:20Z

← Older revision		Revision as of 09:39, 15 December 2023
Line 12:		Line 12:

	<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		<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
	https://myserver.com/propid=1234
			<code>https://myserver.com/propid=1234 </code>

	The URL can contain template variables which will be exchanged with information from the booking.		The URL can contain template variables which will be exchanged with information from the booking.

Annette at 09:38, 15 December 2023

2023-12-15T09:38:42Z

← Older revision		Revision as of 09:38, 15 December 2023
Line 11:		Line 11:
	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.

	If you need to differentiate between multiple properties, an easy way is to include a property parameter in your URL		<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
	https://myserver.com/propid=1234		https://myserver.com/propid=1234

Markkinchin at 09:37, 15 December 2023

2023-12-15T09:37:12Z

← Older revision		Revision as of 09:37, 15 December 2023
Line 10:		Line 10:

	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.

			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 URL can contain template variables which will be exchanged with information from the booking.

Markkinchin at 10:21, 28 May 2022

2022-05-28T10:21:27Z

← Older revision		Revision as of 10:21, 28 May 2022
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.

	The bookid and status are appended to your url like this example.		The bookid and status are appended to your url like this example.

Markkinchin at 16:33, 22 September 2020

2020-09-22T16:33:17Z

← Older revision		Revision as of 16:33, 22 September 2020
Line 7:		Line 7:
	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 ~~modified~~ instead of new and a cancelled booking may have a webhook with status = modify		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.

Markkinchin at 16:30, 22 September 2020

2020-09-22T16:30:14Z

← Older revision		Revision as of 16:30, 22 September 2020
Line 5:		Line 5:
	https://yoururl.com/yourpage?bookid=12345678&status=new		https://yoururl.com/yourpage?bookid=12345678&status=new

	Possible values for status are: new, modify, cancel		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 modified instead of new and a cancelled booking may have a webhook with status = modify

	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.

Markkinchin at 16:09, 9 April 2020

2020-04-09T16:09:59Z

← Older revision		Revision as of 16:09, 9 April 2020
Line 1:		Line 1:
	A push notification 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 or cancellation occurs.

	The bookid and status are appended to your url like this example.		The bookid and status are appended to your url like this example.
Line 16:		Line 16:

	If there is no response or a response HTTP code of 400 or higher the notify will be retried after a delay.		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.

			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.

Markkinchin at 11:35, 28 December 2018

2018-12-28T11:35:47Z

← Older revision		Revision as of 11:35, 28 December 2018
Line 10:		Line 10:

	The URL can contain template variables which will be exchanged with information from the booking.		The URL can contain template variables which will be exchanged with information from the booking.

			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.		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.		If there is no response or a response HTTP code of 400 or higher the notify will be retried after a delay.