New: look up a phone number on its own endpoint, businesses included. See what's changed →
Whitepages Pro API
Webhooks

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.

POST
/v1/webhooks/

Authorization

ApiKeyAuth
x-api-key<token>

API key for authentication. Get your key from the Whitepages developer portal.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Request body for creating a webhook subscription.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/webhooks/" \  -H "Content-Type: application/json" \  -d '{    "url": "https://api.example.com/webhooks/wp-events",    "event_type": "deed.*",    "region": "state:tx"  }'
{
  "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"
  }
}
{
  "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": 422,
    "message": "Unprocessable Entity",
    "long_message": "The request contains semantic errors and cannot be processed",
    "meta": null
  },
  "wp_trace_id": "7e5f2c9a1d8b4e6f9c0a3b5d7e1f2a4c"
}
{
  "message": "Too Many Requests",
  "error": "usage_cap_exceeded",
  "error_instance_id": "1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed",
  "limit": 1000,
  "used": 1000,
  "reset_at": "2026-09-01T00:00:00+00:00",
  "upgrade_url": "https://www.whitepages.com/billing/manage-plan/pro-api"
}
{
  "error": {
    "code": 500,
    "message": "Internal Server Error",
    "long_message": "An internal server error occurred",
    "meta": null
  },
  "wp_trace_id": "9c1a4e7f2b8d4c6a9e0f3b5d7c1a2e4f"
}

Related