Setting/propertiesnotifyurl

From Beds24 Wiki
Jump to navigation Jump to search

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.

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.

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.

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.



新規予約、予約変更、キャンセルが発生すると、このURLにプッシュ通知(Webhook)が送信されます。

予約IDとステータス(予約状況)は次の例のようにURLに追加されます。

https://yoururl.com/yourpage?bookid=12345678&status=new

ステータスに指定できる値は、new, modify, cancel, messageです。

複数のフィールド(予約情報など)が変更された場合、新規またはキャンセルであっても、modifyが送信される可能性があります。

カードのCVVと、JSON getCard API関数からそれを取得するためのトークンは、フォームURLでエンコードされたPOSTデータとして、プッシュのボディに含めることができます。

URLには、予約の情報と変数を含めることができます。

複数のURLを通知することができます。各追加URLを新しい行に入力してください。 あなたのサーバーは、通知を受け取ったことを確認するためにHTTP 200ヘッダーを返す必要があります。 応答がない場合、またはHTTPコードが400以上の場合、通知は時間をおいて再試行されます。 送信メッセージはキューイングされるため、アクションが発生してから通知が送信されるまでに短い時間がかかることがあります。 ステータス値は同期していません。メッセージが送信される前に予約がその状態に変更された場合、最初の通知が新規ではなくステータス修正またはキャンセルになる可能性があります。