Implementation:Elevenlabs Elevenlabs python WebhookToolConfigOutput
| Field | Value |
|---|---|
| source | Elevenlabs_Elevenlabs_python |
| domains | Conversational AI, Tool Configuration, Webhooks |
| last_updated | 2026-02-15 |
Overview
Description
WebhookToolConfigOutput is a Pydantic model representing the output configuration for a webhook tool in the ElevenLabs conversational AI system. A webhook tool is a tool that calls an external webhook from the ElevenLabs server. It defines the tool's name, description, timeout, interruption behavior, sound effects, error handling, dynamic variables, execution mode, and the outgoing webhook API schema. This model is auto-generated by Fern from the ElevenLabs API definition and extends UncheckedBaseModel.
Usage
This model is returned by the ElevenLabs API when retrieving webhook tool configurations. Webhook tools allow the conversational agent to make server-side HTTP calls to external services during a conversation, enabling integrations with third-party APIs and custom backends.
Code Reference
Source Location
src/elevenlabs/types/webhook_tool_config_output.py
Class Signature
class WebhookToolConfigOutput(UncheckedBaseModel):
"""
A webhook tool is a tool that calls an external webhook from our server
"""
...
Import Statement
from elevenlabs.types import WebhookToolConfigOutput
I/O Contract
| Field | Type | Required | Description |
|---|---|---|---|
| name | str |
Yes | The name of the webhook tool. |
| description | str |
Yes | Description of when the tool should be used and what it does. |
| response_timeout_secs | Optional[int] |
No | The maximum time in seconds to wait for the tool call to complete. Must be between 5 and 120 seconds (inclusive). |
| disable_interruptions | Optional[bool] |
No | If true, the user will not be able to interrupt the agent while this tool is running. |
| force_pre_tool_speech | Optional[bool] |
No | If true, the agent will speak before the tool call. |
| assignments | Optional[List[DynamicVariableAssignment]] |
No | Configuration for extracting values from tool responses and assigning them to dynamic variables. |
| tool_call_sound | Optional[ToolCallSoundType] |
No | Predefined tool call sound type to play during tool execution. |
| tool_call_sound_behavior | Optional[ToolCallSoundBehavior] |
No | Determines when the tool call sound should play. 'auto' only plays when there's pre-tool speech, 'always' plays for every tool call. |
| tool_error_handling_mode | Optional[ToolErrorHandlingMode] |
No | Controls how tool errors are processed before being shared with the agent. |
| dynamic_variables | Optional[DynamicVariablesConfig] |
No | Configuration for dynamic variables. |
| execution_mode | Optional[ToolExecutionMode] |
No | Determines when and how the tool executes: 'immediate', 'post_tool_speech', or 'async'. |
| api_schema | WebhookToolApiSchemaConfigOutput |
Yes | The schema for the outgoing webhook, including parameters and URL specification. |
Usage Examples
from elevenlabs.types import WebhookToolConfigOutput
# Typically received as part of an API response
webhook_tool = WebhookToolConfigOutput(
name="order_status",
description="Checks the status of a customer order by order ID.",
response_timeout_secs=15,
disable_interruptions=False,
force_pre_tool_speech=True,
api_schema=WebhookToolApiSchemaConfigOutput(...),
)