Property Status

Our Property Status Webhook will push data to any external system when property status changes occur. We will send the property status for all events and our intent is that the partner or receiving system can decide which events to process and which events not to. Our webhook follows the observer pattern so that other systems can listen for events.

📘

For more information on Property Status set-up and functionality in the web application, please review the Help Guide

🔘 Enabling Property Webhooks

To subscribe to our property webhook, you can utilize the /subscribe endpoint.

The endpoint takes two parameters, url and type_webhook. The url parameter should be an endpoint in the client system which will receive the events triggered in the Breezeway system. For the property webhook, property-status can be passed in the type_webhook parameter. This will create a subscription to the task events, and the client system will begin receiving notifications within an hour.

Example

curl --location -g --request POST 'https://api.breezeway.io/public/webhook/v1/subscribe' \
--header 'Authorization: JWT {{token}} \
--data-raw '{
    "url": "http://www.testwebhooksub.com",
    "webhook_type": "property-status"
}'