Webhooks

Create a webhook subscription

Changed on Sep 12, 2026

Register a new webhook subscription for property events. The endpoint URL is validated on creation — it must be reachable and return a 2xx response. Currently supports deed.* events scoped to Texas counties.

post/v1/webhooks/

Request

Base URL
https://api.whitepages.com
Auth
API key in header x-api-key
TypeScript
https://skmtc.dev/whitepages/apis/whitepages-api-reference/docs/v1/webhooks/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

urlstring required

HTTPS URL where webhook notifications will be delivered via POST. Must use HTTPS.

namestring nullable

Optional human-readable label for identifying this subscription (max 255 characters).

event_typestring required

Event type to subscribe to, in category.* format. Currently only deed.* is supported.

regionstring required

Geographic region in type:value format. Supported types: state:{code} (e.g., state:tx) for an entire state, or county:{state}.{name} (e.g., county:tx.travis) / county:{fips} (e.g., county:48453) for a single county. Currently only Texas and its counties are supported. Use the Regions API to discover valid values: GET /v1/regions/states and GET /v1/regions/states/{state}/counties.

Example request

{
  "url": "https://api.example.com/webhooks/wp-events",
  "name": "Austin metro deed alerts",
  "event_type": "deed.*",
  "region": "state:tx"
}

Response

Webhook created successfully

Example response

{
  "result": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "url": "https://api.example.com/webhooks/wp-events",
    "name": "Austin metro deed alerts",
    "event_type": "deed.*",
    "region": "county:tx.travis",
    "status": "active",
    "created_at": "2026-01-15T09:30:00Z",
    "updated_at": "2026-02-20T14:45:00Z"
  }
}

Changes

Sep 12, 2026a50bd0fbbeb5 Revision changes
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became optional for the status
- breaking
  the response property / became optional for the status
- breaking
  the response property / became optional for the status
- breaking
  the response property / became optional for the status
- info
  removed subschema #2 from the / response property anyOf list for the response status
- info
  removed subschema #2 from the / response property anyOf list for the response status
- info
  the response's property default value 422 was added for the status
- info
  the response's property default value 500 was added for the status
- info
  the response's property default value Internal Server Error was added for the status
- info
  the response's property default value Unprocessable Entity was added for the status
- info
  removed the 100.00 enum value from the / response property for the response status
- info
  removed the 100.00 enum value from the / response property for the response status
- info
  removed the 101.00 enum value from the / response property for the response status
- info
  removed the 101.00 enum value from the / response property for the response status
- info
  removed the 102.00 enum value from the / response property for the response status
- info
  removed the 102.00 enum value from the / response property for the response status
- info
  removed the 103.00 enum value from the / response property for the response status
- info
  removed the 103.00 enum value from the / response property for the response status
- info
  removed the 200.00 enum value from the / response property for the response status
- info
  removed the 200.00 enum value from the / response property for the response status
- info
  removed the 201.00 enum value from the / response property for the response status
- info
  removed the 201.00 enum value from the / response property for the response status
- info
  removed the 202.00 enum value from the / response property for the response status
- info
  removed the 202.00 enum value from the / response property for the response status
- info
  removed the 203.00 enum value from the / response property for the response status
- info
  removed the 203.00 enum value from the / response property for the response status
- info
  removed the 204.00 enum value from the / response property for the response status
- info
  removed the 204.00 enum value from the / response property for the response status
- info
  removed the 205.00 enum value from the / response property for the response status
- info
  removed the 205.00 enum value from the / response property for the response status
- info
  removed the 206.00 enum value from the / response property for the response status
- info
  removed the 206.00 enum value from the / response property for the response status
- info
  removed the 207.00 enum value from the / response property for the response status
- info
  removed the 207.00 enum value from the / response property for the response status
- info
  removed the 208.00 enum value from the / response property for the response status
- info
  removed the 208.00 enum value from the / response property for the response status
- info
  removed the 226.00 enum value from the / response property for the response status
- info
  removed the 226.00 enum value from the / response property for the response status
- info
  removed the 300.00 enum value from the / response property for the response status
- info
  removed the 300.00 enum value from the / response property for the response status
- info
  removed the 301.00 enum value from the / response property for the response status
- info
  removed the 301.00 enum value from the / response property for the response status
- info
  removed the 302.00 enum value from the / response property for the response status
- info
  removed the 302.00 enum value from the / response property for the response status
- info
  removed the 303.00 enum value from the / response property for the response status
- info
  removed the 303.00 enum value from the / response property for the response status
- info
  removed the 304.00 enum value from the / response property for the response status
- info
  removed the 304.00 enum value from the / response property for the response status
- info
  removed the 305.00 enum value from the / response property for the response status
- info
  removed the 305.00 enum value from the / response property for the response status
- info
  removed the 307.00 enum value from the / response property for the response status
- info
  removed the 307.00 enum value from the / response property for the response status
- info
  removed the 308.00 enum value from the / response property for the response status
- info
  removed the 308.00 enum value from the / response property for the response status
- info
  removed the 400.00 enum value from the / response property for the response status
- info
  removed the 400.00 enum value from the / response property for the response status
- info
  removed the 401.00 enum value from the / response property for the response status
- info
  removed the 401.00 enum value from the / response property for the response status
- info
  removed the 402.00 enum value from the / response property for the response status
- info
  removed the 402.00 enum value from the / response property for the response status
- info
  removed the 403.00 enum value from the / response property for the response status
- info
  removed the 403.00 enum value from the / response property for the response status
- info
  removed the 404.00 enum value from the / response property for the response status
- info
  removed the 404.00 enum value from the / response property for the response status
- info
  removed the 405.00 enum value from the / response property for the response status
- info
  removed the 405.00 enum value from the / response property for the response status
- info
  removed the 406.00 enum value from the / response property for the response status
- info
  removed the 406.00 enum value from the / response property for the response status
- info
  removed the 407.00 enum value from the / response property for the response status
- info
  removed the 407.00 enum value from the / response property for the response status
- info
  removed the 408.00 enum value from the / response property for the response status
- info
  removed the 408.00 enum value from the / response property for the response status
- info
  removed the 409.00 enum value from the / response property for the response status
- info
  removed the 409.00 enum value from the / response property for the response status
- info
  removed the 410.00 enum value from the / response property for the response status
- info
  removed the 410.00 enum value from the / response property for the response status
- info
  removed the 411.00 enum value from the / response property for the response status
- info
  removed the 411.00 enum value from the / response property for the response status
- info
  removed the 412.00 enum value from the / response property for the response status
- info
  removed the 412.00 enum value from the / response property for the response status
- info
  removed the 413.00 enum value from the / response property for the response status
- info
  removed the 413.00 enum value from the / response property for the response status
- info
  removed the 413.00 enum value from the / response property for the response status
- info
  removed the 413.00 enum value from the / response property for the response status
- info
  removed the 414.00 enum value from the / response property for the response status
- info
  removed the 414.00 enum value from the / response property for the response status
- info
  removed the 414.00 enum value from the / response property for the response status
- info
  removed the 414.00 enum value from the / response property for the response status
- info
  removed the 415.00 enum value from the / response property for the response status
- info
  removed the 415.00 enum value from the / response property for the response status
- info
  removed the 416.00 enum value from the / response property for the response status
- info
  removed the 416.00 enum value from the / response property for the response status
- info
  removed the 416.00 enum value from the / response property for the response status
- info
  removed the 416.00 enum value from the / response property for the response status
- info
  removed the 417.00 enum value from the / response property for the response status
- info
  removed the 417.00 enum value from the / response property for the response status
- info
  removed the 418.00 enum value from the / response property for the response status
- info
  removed the 418.00 enum value from the / response property for the response status
- info
  removed the 421.00 enum value from the / response property for the response status
- info
  removed the 421.00 enum value from the / response property for the response status
- info
  removed the 422.00 enum value from the / response property for the response status
- info
  removed the 422.00 enum value from the / response property for the response status
- info
  removed the 422.00 enum value from the / response property for the response status
- info
  removed the 422.00 enum value from the / response property for the response status
- info
  removed the 423.00 enum value from the / response property for the response status
- info
  removed the 423.00 enum value from the / response property for the response status
- info
  removed the 424.00 enum value from the / response property for the response status
- info
  removed the 424.00 enum value from the / response property for the response status
- info
  removed the 425.00 enum value from the / response property for the response status
- info
  removed the 425.00 enum value from the / response property for the response status
- info
  removed the 426.00 enum value from the / response property for the response status
- info
  removed the 426.00 enum value from the / response property for the response status
- info
  removed the 428.00 enum value from the / response property for the response status
- info
  removed the 428.00 enum value from the / response property for the response status
- info
  removed the 429.00 enum value from the / response property for the response status
- info
  removed the 429.00 enum value from the / response property for the response status
- info
  removed the 431.00 enum value from the / response property for the response status
- info
  removed the 431.00 enum value from the / response property for the response status
- info
  removed the 451.00 enum value from the / response property for the response status
- info
  removed the 451.00 enum value from the / response property for the response status
- info
  removed the 500.00 enum value from the / response property for the response status
- info
  removed the 500.00 enum value from the / response property for the response status
- info
  removed the 501.00 enum value from the / response property for the response status
- info
  removed the 501.00 enum value from the / response property for the response status
- info
  removed the 502.00 enum value from the / response property for the response status
- info
  removed the 502.00 enum value from the / response property for the response status
- info
  removed the 503.00 enum value from the / response property for the response status
- info
  removed the 503.00 enum value from the / response property for the response status
- info
  removed the 504.00 enum value from the / response property for the response status
- info
  removed the 504.00 enum value from the / response property for the response status
- info
  removed the 505.00 enum value from the / response property for the response status
- info
  removed the 505.00 enum value from the / response property for the response status
- info
  removed the 506.00 enum value from the / response property for the response status
- info
  removed the 506.00 enum value from the / response property for the response status
- info
  removed the 507.00 enum value from the / response property for the response status
- info
  removed the 507.00 enum value from the / response property for the response status
- info
  removed the 508.00 enum value from the / response property for the response status
- info
  removed the 508.00 enum value from the / response property for the response status
- info
  removed the 510.00 enum value from the / response property for the response status
- info
  removed the 510.00 enum value from the / response property for the response status
- info
  removed the 511.00 enum value from the / response property for the response status
- info
  removed the 511.00 enum value from the / response property for the response status
Sep 1, 2026c27a0cd8718f Revision changes
- info
  endpoint added

Operation history