Skip to navigation

Send Test Webhook Event

Sends a sample event of the given type to the webhook once and returns the endpoint's status code, response time, content type and response size. Test events are signed like real ones, are never retried, and share a limit of 10 per webhook per minute with redeliveries.

Path parameters

webhook_idstringRequired
The ID of the webhook.

Headers

xi-api-keystringOptional

Request

This endpoint expects an object.
webhook_typeenumRequired
The event type to send a sample of.

Response

Successful Response
delivery_idstring

The delivery ID, also sent in the ElevenLabs-Webhook-Delivery-Id header.

outcomeenum
What happened to this attempt.
response_codeinteger or null
The HTTP status your endpoint returned, if it answered.
latency_msinteger or null
How long your endpoint took to answer, in milliseconds.
response_content_typestring or null

The Content-Type your endpoint answered with, if it answered.

response_body_bytesinteger or null
The size of your endpoint's response body in bytes, if it answered. The body itself is never stored or returned.
failure_originstring or null

Where a failure came from: recipient, configuration, external_transport or timeout.

Errors

422
Unprocessable Entity Error