Feed & webhook
Each API key can store a filter and an HTTPS webhook URL (admin → key settings).
GET /v1/feed
Pulls applications matching the saved filter, firstSeenAt ≥ since (default: 7 days ago), ordered by estimated value then recency, max 200.
{ "filters": { }, "since": "…", "data": [ /* Lead */ ] }
Daily webhook
About once per day, if webhookUrl is set, the worker POSTs new matches (firstSeenAt after the last successful delivery):
POST https://your.endpoint/hooks/permits
Content-Type: application/json
{
"since": "2026-11-20T00:00:00.000Z",
"until": "2026-11-21T00:00:00.000Z",
"filters": { "minUnits": 20 },
"applications": [ /* Lead */ ]
}
- HTTPS only
- Respond with any
2xxto acknowledge - Failed delivery is retried about an hour later; empty match sets still advance the watermark without a POST body of applications when there is nothing to send (no POST if zero matches)
Configure filters and webhook in admin under the key's gear / settings page.