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

# Test webhook configuration for an application

> Sends a test webhook request to the configured webhook URL with a sample payload. Returns success status and any error details.



## OpenAPI

````yaml https://app.stainless.com/api/spec/documented/avido/openapi.documented.yml post /v0/webhook/test
openapi: 3.1.1
info:
  title: Avido API
  description: >-
    Avido's API for LLM usage events, tool calls, trace management, webhook
    validation, and more. See each endpoint's request/response schema for
    details.
  version: 0.1.0
  contact:
    name: Avido Support
    email: support@avidoai.com
    url: https://avidoai.com/support
servers:
  - url: https://api.avidoai.com
    description: Production API
security:
  - ApiKey: []
    ApplicationId: []
paths:
  /v0/webhook/test:
    post:
      tags:
        - Webhook
      summary: Test webhook configuration for an application
      description: >-
        Sends a test webhook request to the configured webhook URL with a sample
        payload. Returns success status and any error details.
      operationId: testWebhook
      responses:
        '200':
          description: Test webhook request completed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestWebhookResponse'
              examples:
                success:
                  summary: Webhook test successful
                  value:
                    success: true
                    statusCode: 200
                failure:
                  summary: Webhook test failed
                  value:
                    success: false
                    statusCode: 500
                    error: 'Webhook failed with status=500: Internal Server Error'
        '400':
          description: bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Application or webhook not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: invalid input
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorResponse'
        '500':
          description: internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    TestWebhookResponse:
      type: object
      properties:
        success:
          type: boolean
          description: Whether the webhook test was successful
          example: true
        statusCode:
          description: HTTP status code returned by the webhook endpoint
          example: 200
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
        error:
          description: Error message if the webhook test failed
          example: Webhook failed with status=500
          type: string
      required:
        - success
      additionalProperties: false
      title: TestWebhookResponse
      description: Response indicating whether the webhook test was successful
    ErrorResponse:
      type: object
      properties:
        message:
          type: string
          description: A human-readable error message explaining the error.
          example: Resource not found
      required:
        - message
      additionalProperties: false
      title: ErrorResponse
      description: Standard error format for failed API operations.
    ValidationErrorResponse:
      type: object
      properties:
        message:
          type: string
          description: A human-readable error message indicating what went wrong.
          example: Invalid request data
        issues:
          type: array
          items:
            type: object
            properties:
              code:
                type: string
              message:
                type: string
              path:
                type: array
                items:
                  type: string
            required:
              - code
              - message
              - path
            additionalProperties: false
          description: Array of detailed validation error objects.
          example:
            - code: invalid_string
              message: Invalid UUID
              path:
                - id
      required:
        - message
        - issues
      additionalProperties: false
      title: ValidationErrorResponse
      description: Details about validation errors in incoming requests.
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: Your unique Avido API key
    ApplicationId:
      type: apiKey
      in: header
      name: x-application-id
      description: Your unique Avido Application ID

````