Send Test Ping
Send a synthetic test payload to one endpoint, bypassing Kafka entirely.
Returns the result synchronously and does NOT write a WebhookDeliveryAttempt row - pings are not part of the real event stream (see the design spec's Backend management API section).
The target host is re-resolved and validated against SSRF-disallowed
IP ranges immediately before dispatch, and the HTTP connection is
pinned to the validated IP (see send_webhook's connect_ip
parameter) - the same protection applied to real event dispatch in
webhook-worker's dispatcher.py, since the ping button is just as
capable of reaching an internal service or the cloud metadata
endpoint as the real delivery path.
Authorization
OAuth2AuthorizationCodeBearer AuthorizationBearer <token>
In: header
Path Parameters
endpoint_id*Endpoint Id
Format
uuidQuery Parameters
verify_locally?Verify Locally
Default
trueResponse Body
application/json
application/json
curl -X POST "https://example.com/v1/webhooks/497f6eca-6276-4993-bfeb-53cbbbba6f08/ping"{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "event_id": "a7a26ff2-e851-45b6-9634-d595f45458b7", "event_type": "string", "attempt_number": 0, "http_status": 0, "error": "string", "duration_ms": 0, "succeeded": true, "created_at": "2019-08-24T14:15:22Z"}{ "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ]}