Implementation:Elevenlabs Elevenlabs python ApiIntegrationWebhookToolConfigOutput
| Field | Value |
|---|---|
| source | Elevenlabs_Elevenlabs_python |
| domains | Conversational AI, Tool Configuration, API Integration, Webhooks |
| last_updated | 2026-02-15 |
Overview
Description
ApiIntegrationWebhookToolConfigOutput is a Pydantic model representing the output configuration for an API integration webhook tool in the ElevenLabs conversational AI system. This tool type connects to external API integrations via webhooks and includes configuration for the tool's behavior, sound effects, error handling, dynamic variables, execution mode, and API integration identifiers. Most fields are required (non-optional), reflecting that this is an output model with fully resolved configuration values. 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 tool configurations that are backed by API integrations. It provides the complete, resolved configuration for a webhook-based tool including the API integration connection details and optional schema overrides.
Code Reference
Source Location
src/elevenlabs/types/api_integration_webhook_tool_config_output.py
Class Signature
class ApiIntegrationWebhookToolConfigOutput(UncheckedBaseModel):
...
Import Statement
from elevenlabs.types import ApiIntegrationWebhookToolConfigOutput
I/O Contract
| Field | Type | Required | Description |
|---|---|---|---|
| name | str |
Yes | The name of the tool. |
| description | str |
Yes | Description of when the tool should be used and what it does. |
| response_timeout_secs | int |
Yes | The maximum time in seconds to wait for the tool call to complete. Must be between 5 and 120 seconds (inclusive). |
| disable_interruptions | bool |
Yes | If true, the user will not be able to interrupt the agent while this tool is running. |
| force_pre_tool_speech | bool |
Yes | If true, the agent will speak before the tool call. |
| assignments | List[DynamicVariableAssignment] |
Yes | 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 | ToolCallSoundBehavior |
Yes | 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 | ToolErrorHandlingMode |
Yes | Controls how tool errors are processed before being shared with the agent. |
| dynamic_variables | DynamicVariablesConfig |
Yes | Configuration for dynamic variables. |
| execution_mode | ToolExecutionMode |
Yes | Determines when and how the tool executes: 'immediate', 'post_tool_speech', or 'async'. |
| tool_version | str |
Yes | The version of the API integration tool. |
| api_integration_id | str |
Yes | Identifier for the API integration. |
| api_integration_connection_id | str |
Yes | Identifier for the API integration connection. |
| api_schema_overrides | Optional[ApiIntegrationWebhookOverridesOutput] |
No | User overrides applied on top of the base api_schema. |
Usage Examples
from elevenlabs.types import ApiIntegrationWebhookToolConfigOutput
# Typically received as part of an API response
tool_config = ApiIntegrationWebhookToolConfigOutput(
name="crm_lookup",
description="Looks up customer information in the CRM system.",
response_timeout_secs=30,
disable_interruptions=False,
force_pre_tool_speech=True,
assignments=[],
tool_call_sound_behavior="auto",
tool_error_handling_mode="summarized",
dynamic_variables=DynamicVariablesConfig(...),
execution_mode="immediate",
tool_version="1.0",
api_integration_id="integration_abc123",
api_integration_connection_id="conn_xyz789",
)