Introducing Webhooks — Get live property deed updates delivered to you. Learn more →
Whitepages
Webhooks

Get a webhook subscription

Retrieve a single webhook subscription by its ID.

GET
/v1/webhooks/{webhook_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

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.whitepages.com/v1/webhooks/string"
{
  "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": 404,
    "message": "Not Found",
    "long_message": "Person id not found: PABcd12345e",
    "meta": null
  },
  "wp_trace_id": "0c57473114bd49b3b3c4b585df624f2f"
}
{
  "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"
}