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.

post/v1/webhooks/{webhook_id}/test

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

No recorded changes to this endpoint across all 1 revision of this API.