BRbreezeway

Create subscription

URL validation enforced. URLs must be valid and able to return a success status code.

post/subscribe

Request

  • Base URL
    https://api.breezeway.io/public/webhook/v1
  • URL
    https://api.breezeway.io/public/webhook/v1/subscribe
  • Auth
    API key in header Authorization

Request body

urlstring required

URL to receive POST request

webhook_type'property-status' | 'task' required
company_idinteger

Required if using cross-company access

Response

200

messagestring
idinteger
company_idinteger
urlstring
webhook_typestring

Example response

{
  "message": "Subscription successful",
  "id": 1,
  "company_id": 1,
  "url": "https://test.com",
  "webhook_type": "task"
}

Changes

No recorded changes to this operation across all 1 revision of this API.