Supported events

Depending on your level of access, the Breezeway platform supports events for Breezeway property status changes and task updates. The subscriptions for these events are managed independently.

Configuring your subscription

To establish a subscription, make a POST request to the webhook /subscribe endpoint, with the endpoint at which you wish to receive webhook events. Specify the webhook type from the supported events (property-status or task).

curl --request POST \
     --url https://api.breezeway.io/public/webhook/v1/subscribe \
     --header 'Authorization: JWT {{token}}' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "webhook_type": "property-status",
  "url": "https://example.com/test-webhook/"
}
'

The endpoint provided for your subscription must be a valid URL, and must be able to respond successfully (i.e. an HTTP 2XX response). A test API call will be made during your subscription attempt to verify we can send events successfully.

The test event will contain a JSON payload of {"event": "test_webhook_event"}. If your server responds with an HTTP success response, the Breezeway platform will respond with the details of your subscription. The id property will contain your unique subscription identifier, which can be used for removing your subscription if needed.

{
  "message": "Subscription successful",
  "id": 1,
  "company_id": 1,
  "url": "https://example.com/test-webhook/",
  "webhook_type": "property-status"
}

Responding to events

The Breezeway webhook events system is configured to maintain optimal operation for all subscribers. As such, there are system checks in place to ensure each subscription continues to respond efficiently.

For all requests posted, your endpoint must respond within 10 seconds for the response to be considered successful.

Maintaining and monitoring your subscription

Continued failed requests to your endpoint will result in the subscription being automatically deactivated. We recommend you monitor the status of your subscription by routinely checking your active subscriptions. An endpoint exceeding an outage grace period of 3 days with a minimum of 10 consecutive failed requests will result in the subscription being deactivated. If this happens, please resolve the issues affecting your endpoint and create a new subscription.

Cross-Company Access

❗️

Partners & Enterprise Accounts

If you're a partner with cross-company access, you'll need permission to subscribe to webhooks. Please contact us to gain access.

Once our team confirms that access has been granted, you can proceed with subscribing to webhook events.

To establish a subscription, make a POST request to the webhook /subscribe endpoint, with the endpoint at which you wish to receive webhook events. Specify the webhook type from the supported events (property-status or task). In this case, you will also need to provide thecompany_id for which you wish to receive events at the designated endpoint.

curl --request POST \
     --url https://api.breezeway.io/public/webhook/v1/subscribe \
     --header 'Authorization: JWT {{token}}' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "webhook_type": "property-status",
  "url": "https://example.com/test-webhook/",
  "company_id": {{breezeway_company_id}}
}
'