Send a ping event to a webhook
POST/v1/webhooks/{webhook_id}/ping
POST
/v1/webhooks/{webhook_id}/ping
Enqueue a synthetic ping delivery so receivers can verify HMAC + connectivity.
The webhook must include ping in its events list, or the ping is still
force-delivered to this endpoint only (not fan-out).
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”webhook_id
required
Webhook Id
string format: uuid
Responses
Section titled “Responses”Successful Response
PingWebhookResponse
object
event_id
required
Event Id
string
delivery_id
required
Delivery Id
string
Not Found
GenericError
object
detail
Detail
Validation Error
HTTPValidationError
object
detail
Detail
Array<object>
ValidationErrorobject
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string