Test a webhook delivery
Send a synthetic notification to the webhook endpoint. Uses the same payload format as real deliveries with a fixed event ID.
Authorization
ApiKeyAuth API key for authentication. Get your key from the Whitepages developer portal.
In: header
Path Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Request body for testing a webhook delivery.
Sends a synthetic notification to the webhook endpoint using the same format as real deliveries. The event ID is a fixed identifier to distinguish test payloads.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/webhooks/string/test" \ -H "Content-Type: application/json" \ -d '{}'{
"success": true,
"delivery": {
"status_code": 200,
"response_time_ms": 142,
"timestamp": "2026-02-20T14:45:00Z"
},
"payload": {
"event_id": "evt_abc123",
"event_type": "deed.*",
"links": [
{
"version": "1",
"url": "https://api.whitepages.com/v1/events/evt_abc123"
}
]
}
}{
"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": 404,
"message": "Not Found",
"long_message": "Person id not found: PABcd12345e",
"meta": null
},
"wp_trace_id": "0c57473114bd49b3b3c4b585df624f2f"
}{
"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"
}{
"error": {
"code": 500,
"message": "Internal Server Error",
"long_message": "An internal server error occurred",
"meta": null
},
"wp_trace_id": "9c1a4e7f2b8d4c6a9e0f3b5d7c1a2e4f"
}Related
Test a Webhook
Send a mock event payload to verify your webhook endpoint
Create a webhook subscription
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.
Authentication
Learn how to authenticate your requests to the Whitepages Pro API.