Webhooks
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 x-api-key<token>
API key for authentication. Get your key from the Whitepages developer portal.
In: header
Path Parameters
webhook_id*string
Request Body
application/json
event_type?Event Type|Event Type
Event type to simulate. If omitted, defaults to the event type the webhook is subscribed to.
Example
"deed.*"Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://api.whitepages.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": 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"
}