> ## Documentation Index
> Fetch the complete documentation index at: https://voice.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Test Tools Webhook

> Send a sample function-call payload to the configured webhooks.tools entry for the given tool name and return the delivery result. It does not invoke webhooks.inbound_call.



## OpenAPI

````yaml /docs/openapi.json post /api/v1/agent/{agent_id}/webhook/test-tool/{tool_name}
openapi: 3.1.0
info:
  title: Voice AI Developer API
  description: >-
    Generate realistic speech and clone voices. AI voice agents with retrieval
    augmented generation (RAG) and model context protocol (MCP) included.
  version: 1.5.0
  contact: {}
servers:
  - url: https://dev.voice.ai
    description: HTTP API endpoints
security:
  - BearerAuth: []
tags:
  - name: Text To Speech
    description: Text-to-speech endpoints for voice cloning and speech generation.
  - name: Pronunciation Dictionaries
    description: Manage versioned pronunciation dictionaries for TTS and voice agents.
  - name: Agent Management
    description: Create, update, deploy, and manage voice agents.
  - name: Models
    description: Discover supported LLM and TTS model options.
  - name: Agent Connection
    description: Connect to agents and manage active calls.
  - name: Agent Analytics
    description: >-
      Analytics and reporting for agent performance, call history, and
      statistics.
  - name: Agent Knowledge Base
    description: >-
      Manage knowledge bases for retrieval augmented generation (RAG) with your
      agents.
  - name: Phone Number Management
    description: >-
      Search, select, and manage phone numbers from your plan allocation.
      Release numbers to free up slots.
  - name: Managed Tools
    description: >-
      Connect Google Calendar, Sheets, and Gmail to agents and inspect
      connection state.
paths:
  /api/v1/agent/{agent_id}/webhook/test-tool/{tool_name}:
    post:
      tags:
        - Agent Management
      summary: Test Tools Webhook
      description: >-
        Send a sample function-call payload to the configured webhooks.tools
        entry for the given tool name and return the delivery result. It does
        not invoke webhooks.inbound_call.
      operationId: >-
        test_webhook_tool_api_v1_agent__agent_id__webhook_test_tool__tool_name__post
      parameters:
        - name: agent_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Agent ID
          description: The agent ID that owns the tools webhook
        - name: tool_name
          in: path
          required: true
          schema:
            type: string
            title: Tool Name
          description: Name of the tools webhook to test
      responses:
        '200':
          description: Tools webhook test result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookTestResponse'
        '400':
          description: Webhook tool not configured or disabled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookTestResponse'
        '404':
          description: Agent or tool not found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    WebhookTestResponse:
      properties:
        status:
          type: string
          title: Status
          description: Test result status
          enum:
            - success
            - failed
        message:
          type: string
          title: Message
          description: Human-readable result description
        results:
          type: array
          items:
            $ref: '#/components/schemas/WebhookTestResult'
          title: Results
          description: Per-endpoint delivery results
      required:
        - status
        - message
        - results
      type: object
      title: WebhookTestResponse
      description: Response from webhook test endpoint
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    WebhookTestResult:
      properties:
        url:
          type: string
          title: URL
          description: Webhook endpoint URL that was tested
        success:
          type: boolean
          title: Success
          description: Whether delivery to this endpoint succeeded
        status_code:
          type: integer
          title: Status Code
          description: HTTP status code returned by the endpoint when available
          nullable: true
        attempts:
          type: integer
          title: Attempts
          description: Number of delivery attempts made for this endpoint
        error:
          type: string
          title: Error
          description: Error details if delivery to this endpoint failed
          nullable: true
      required:
        - url
        - success
        - attempts
      type: object
      title: WebhookTestResult
      description: Per-endpoint delivery result from the webhook test endpoint
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Bearer token authentication. Use your API key as the bearer token.
        Format: Authorization: Bearer <your-api-key>

````