Skip to main content
POST
/
webhooks
Register a webhook
curl --request POST \
  --url https://borough.qwady.com/v1/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://myapp.com/webhooks/borough",
  "events": [
    "new_listing",
    "price_drop"
  ],
  "filters": {
    "areas": [
      120,
      115
    ],
    "maxPrice": 5000,
    "minBeds": 2,
    "buildingTypes": [
      "CONDO",
      "CO_OP"
    ]
  }
}
'
{
  "data": {
    "id": "<string>",
    "url": "<string>",
    "events": [
      "<string>"
    ],
    "filters": {},
    "secret": "<string>",
    "isActive": true,
    "createdAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

Polar.sh license key. Format: BOROUGH_<uuid>

Body

application/json
​
url
string<uri>
required

HTTPS endpoint to receive webhook payloads

​
events
enum<string>[]
required
Available options:
new_listing,
price_drop,
status_change
​
filters
object

Response

Webhook registered

​
data
object