ELelevenlabs

Send Test Webhook Event

Changed on

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.

post/v1/workspace/webhooks/{webhook_id}/test

Request

  • Base URL
    https://api.elevenlabs.io (the document declares no server; this is the origin it was published from)
  • Auth
    none declared

Path parameters

webhook_idstring required

The ID of the webhook.

Headers

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Request body

webhook_type'project_conversion_status' | 'chapter_conversion_status' | 'post_call_transcription' | 'post_call_transcription_otel' | 'post_call_audio' | 'post_call_unredacted_transcription' | 'post_call_unredacted_transcription_otel' | 'post_call_unredacted_audio' | 'post_call_analysis' | 'call_initiation_failure' | 'conversation_initiation_client_data' | 'answering_machine_detection' | 'voice_removal_notice' | 'voice_removal_notice_withdrawn' | 'voice_removed' | 'speech_to_text_transcription' | 'webhook_error' | 'speech_to_text_batch' | 'agent_qa_evaluation_completed' | 'convai_alerting_notification' | 'flows_generation' | 'flows_template_run' | 'dubbing_project_ready' | 'dubbing_project_failed' | 'dubbing_language_completed' | 'dubbing_language_failed' | 'support_ticket_message_added' required

Response

Successful Response

delivery_idstring required

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

outcome'delivered' | 'failed_retry_scheduled' | 'failed_exhausted' | 'failed_no_retry' | 'failed_retry_error' | 'dropped_queue_full' | 'dropped_payload_too_large' | 'skipped_disabled' | 'not_sent_configuration' required
response_codeinteger nullable required

The HTTP status your endpoint returned, if it answered.

latency_msinteger nullable required

How long your endpoint took to answer, in milliseconds.

response_content_typestring nullable required

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

response_body_bytesinteger nullable required

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

failure_originstring nullable required

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

Changes