Webhooks
List webhook subscriptions
List all webhook subscriptions for the authenticated account. Optionally filter by status or event type.
Authorization
ApiKeyAuth x-api-key<token>
API key for authentication. Get your key from the Whitepages developer portal.
In: header
Query Parameters
status?Status|Status
Filter by status (active/inactive)
event_type?Event Type|Event Type
Filter by subscribed event type
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://api.whitepages.com/v1/webhooks/"{
"results": [
{
"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"
}
]
}{
"error": {
"code": 400,
"message": "Bad Request",
"long_message": "Invalid person ID format: 'sdf'. Person ID must start with 'P' followed by exactly 10 alphanumeric characters. Example: 'PABcd12345e' or 'P1234567890'.",
"meta": null
},
"wp_trace_id": "3b0b537a60d84057817bb40563ca5c99"
}{
"message": "Forbidden"
}{
"error": {
"code": 400,
"message": "Short error message",
"long_message": "The request was malformed",
"meta": {
"field": "email",
"validation_error": "Invalid email format"
}
},
"wp_trace_id": "550e8400-e29b-41d4-a716-446655440000"
}{
"error": {
"code": 400,
"message": "Short error message",
"long_message": "The request was malformed",
"meta": {
"field": "email",
"validation_error": "Invalid email format"
}
},
"wp_trace_id": "550e8400-e29b-41d4-a716-446655440000"
}Create a webhook subscription POST
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.
Get a webhook subscription GET
Retrieve a single webhook subscription by its ID.