API Reference

Create Webhook

Register a URL to receive listing change events — created, price moved, status changed, or expired. Returns a signing secret for payload verification.

The signing secret appears only in this response (list and update never return it), so store it now; to rotate it, create a new subscription and delete the old one. url must be HTTPS on a public host (loopback, private and link-local addresses are rejected with 400), and events takes 1-10 entries.

Borough publishes detected changes every 5 minutes in capped batches, so a large burst can take several cycles to drain. New-listing, status and expiry events follow the search refresh cadence (about every 6h for rentals, 8h for sales). Price events for detail-scraped listings are detected only when that listing’s detail is refreshed, which can lag the real change by days to weeks; use a listing watcher when price latency matters.

Subscriptions are matched on event type only. An active subscription receives every change of a subscribed type across the whole Borough dataset — subscribing to listing.created means every new listing Borough indexes, citywide. Narrow it either by filtering on data.listingId in your handler, or by using Watchers (POST /v1/watchers), which scope monitoring to one listing, one building, or one saved search.

If the account drops below Business, every webhook subscription and watcher on it is paused. Re-subscribing does not resume them: send PATCH with {"active": true} for each one. Events that occur while a subscription is paused are not delivered later.

Tier: Business

POST

webhooks

curl --request POST \
  --url https://borough.qwady.app/v1/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://myapp.com/webhooks/borough",
  "events": [
    "listing.created",
    "listing.price_decreased"
  ]
}
'

import requests

url = "https://borough.qwady.app/v1/webhooks"

payload = {
    "url": "https://myapp.com/webhooks/borough",
    "events": ["listing.created", "listing.price_decreased"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    url: 'https://myapp.com/webhooks/borough',
    events: ['listing.created', 'listing.price_decreased']
  })
};

fetch('https://borough.qwady.app/v1/webhooks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://borough.qwady.app/v1/webhooks",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'url' => 'https://myapp.com/webhooks/borough',
    'events' => [
        'listing.created',
        'listing.price_decreased'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://borough.qwady.app/v1/webhooks"

	payload := strings.NewReader("{\n  \"url\": \"https://myapp.com/webhooks/borough\",\n  \"events\": [\n    \"listing.created\",\n    \"listing.price_decreased\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://borough.qwady.app/v1/webhooks")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"https://myapp.com/webhooks/borough\",\n  \"events\": [\n    \"listing.created\",\n    \"listing.price_decreased\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://borough.qwady.app/v1/webhooks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"https://myapp.com/webhooks/borough\",\n  \"events\": [\n    \"listing.created\",\n    \"listing.price_decreased\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "<string>",
    "url": "<string>",
    "events": [
      "<string>"
    ],
    "active": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "secret": "<string>"
  }
}

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:

listing.created,

listing.price_decreased,

listing.price_increased,

listing.status_changed,

listing.expired

Response

Webhook registered

data

object

Show child attributes

curl --request POST \
  --url https://borough.qwady.app/v1/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://myapp.com/webhooks/borough",
  "events": [
    "listing.created",
    "listing.price_decreased"
  ]
}
'

import requests

url = "https://borough.qwady.app/v1/webhooks"

payload = {
    "url": "https://myapp.com/webhooks/borough",
    "events": ["listing.created", "listing.price_decreased"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    url: 'https://myapp.com/webhooks/borough',
    events: ['listing.created', 'listing.price_decreased']
  })
};

fetch('https://borough.qwady.app/v1/webhooks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://borough.qwady.app/v1/webhooks",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'url' => 'https://myapp.com/webhooks/borough',
    'events' => [
        'listing.created',
        'listing.price_decreased'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://borough.qwady.app/v1/webhooks"

	payload := strings.NewReader("{\n  \"url\": \"https://myapp.com/webhooks/borough\",\n  \"events\": [\n    \"listing.created\",\n    \"listing.price_decreased\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://borough.qwady.app/v1/webhooks")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"https://myapp.com/webhooks/borough\",\n  \"events\": [\n    \"listing.created\",\n    \"listing.price_decreased\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://borough.qwady.app/v1/webhooks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"https://myapp.com/webhooks/borough\",\n  \"events\": [\n    \"listing.created\",\n    \"listing.price_decreased\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "<string>",
    "url": "<string>",
    "events": [
      "<string>"
    ],
    "active": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "secret": "<string>"
  }
}

Getting Started

Guides

Reference

API Reference

MCP Server

SDK

Create Webhook

Authorizations

Body

Response