Webhooks

Test a webhook delivery

Changed on Sep 12, 2026

Send a synthetic notification to the webhook endpoint. Uses the same payload format as real deliveries with a fixed event ID.

post/v1/webhooks/{webhook_id}/test

Request

Base URL
https://api.whitepages.com
Auth
API key in header x-api-key
TypeScript
https://skmtc.dev/whitepages/apis/whitepages-api-reference/docs/v1/webhooks/:webhook_id/test/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

webhook_idstring required

Request body

event_typestring nullable

Event type to simulate. If omitted, defaults to the event type the webhook is subscribed to.

Example request

{
  "event_type": "deed.*"
}

Response

Test delivery completed

successboolean required

Whether the test delivery succeeded (endpoint returned a 2xx status code).

Example response

{
  "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"
      }
    ]
  }
}

Changes

Sep 12, 2026a50bd0fbbeb5 Revision changes
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became optional for the status
- breaking
  the response property / became optional for the status
- info
  removed subschema #2 from the / response property anyOf list for the response status
- info
  the response's property default value 500 was added for the status
- info
  the response's property default value Internal Server Error was added for the status
- info
  removed the 100.00 enum value from the / response property for the response status
- info
  removed the 101.00 enum value from the / response property for the response status
- info
  removed the 102.00 enum value from the / response property for the response status
- info
  removed the 103.00 enum value from the / response property for the response status
- info
  removed the 200.00 enum value from the / response property for the response status
- info
  removed the 201.00 enum value from the / response property for the response status
- info
  removed the 202.00 enum value from the / response property for the response status
- info
  removed the 203.00 enum value from the / response property for the response status
- info
  removed the 204.00 enum value from the / response property for the response status
- info
  removed the 205.00 enum value from the / response property for the response status
- info
  removed the 206.00 enum value from the / response property for the response status
- info
  removed the 207.00 enum value from the / response property for the response status
- info
  removed the 208.00 enum value from the / response property for the response status
- info
  removed the 226.00 enum value from the / response property for the response status
- info
  removed the 300.00 enum value from the / response property for the response status
- info
  removed the 301.00 enum value from the / response property for the response status
- info
  removed the 302.00 enum value from the / response property for the response status
- info
  removed the 303.00 enum value from the / response property for the response status
- info
  removed the 304.00 enum value from the / response property for the response status
- info
  removed the 305.00 enum value from the / response property for the response status
- info
  removed the 307.00 enum value from the / response property for the response status
- info
  removed the 308.00 enum value from the / response property for the response status
- info
  removed the 400.00 enum value from the / response property for the response status
- info
  removed the 401.00 enum value from the / response property for the response status
- info
  removed the 402.00 enum value from the / response property for the response status
- info
  removed the 403.00 enum value from the / response property for the response status
- info
  removed the 404.00 enum value from the / response property for the response status
- info
  removed the 405.00 enum value from the / response property for the response status
- info
  removed the 406.00 enum value from the / response property for the response status
- info
  removed the 407.00 enum value from the / response property for the response status
- info
  removed the 408.00 enum value from the / response property for the response status
- info
  removed the 409.00 enum value from the / response property for the response status
- info
  removed the 410.00 enum value from the / response property for the response status
- info
  removed the 411.00 enum value from the / response property for the response status
- info
  removed the 412.00 enum value from the / response property for the response status
- info
  removed the 413.00 enum value from the / response property for the response status
- info
  removed the 413.00 enum value from the / response property for the response status
- info
  removed the 414.00 enum value from the / response property for the response status
- info
  removed the 414.00 enum value from the / response property for the response status
- info
  removed the 415.00 enum value from the / response property for the response status
- info
  removed the 416.00 enum value from the / response property for the response status
- info
  removed the 416.00 enum value from the / response property for the response status
- info
  removed the 417.00 enum value from the / response property for the response status
- info
  removed the 418.00 enum value from the / response property for the response status
- info
  removed the 421.00 enum value from the / response property for the response status
- info
  removed the 422.00 enum value from the / response property for the response status
- info
  removed the 422.00 enum value from the / response property for the response status
- info
  removed the 423.00 enum value from the / response property for the response status
- info
  removed the 424.00 enum value from the / response property for the response status
- info
  removed the 425.00 enum value from the / response property for the response status
- info
  removed the 426.00 enum value from the / response property for the response status
- info
  removed the 428.00 enum value from the / response property for the response status
- info
  removed the 429.00 enum value from the / response property for the response status
- info
  removed the 431.00 enum value from the / response property for the response status
- info
  removed the 451.00 enum value from the / response property for the response status
- info
  removed the 500.00 enum value from the / response property for the response status
- info
  removed the 501.00 enum value from the / response property for the response status
- info
  removed the 502.00 enum value from the / response property for the response status
- info
  removed the 503.00 enum value from the / response property for the response status
- info
  removed the 504.00 enum value from the / response property for the response status
- info
  removed the 505.00 enum value from the / response property for the response status
- info
  removed the 506.00 enum value from the / response property for the response status
- info
  removed the 507.00 enum value from the / response property for the response status
- info
  removed the 508.00 enum value from the / response property for the response status
- info
  removed the 510.00 enum value from the / response property for the response status
- info
  removed the 511.00 enum value from the / response property for the response status
Sep 1, 2026c27a0cd8718f Revision changes
- info
  endpoint added

Operation history