> ## Documentation Index
> Fetch the complete documentation index at: https://vlyai-1c28d863.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Send a test webhook

> Send a sample event to a configured webhook endpoint. Useful for verifying signature handling.

Sends a synthetic event to the registered webhook URL. The payload mirrors a real event; the signature is computed with your real signing secret so handlers can be verified end-to-end.

Available test events: `project.created`, `deployment.succeeded`, `deployment.failed`, `agent.completed`.

<Note>
  For full webhook documentation, see the [Webhooks recipe](/recipes/webhooks).
</Note>


## OpenAPI

````yaml POST /v1/webhooks/test
openapi: 3.1.0
info:
  title: vly.ai API
  version: 0.1.0
  description: >-
    REST API for the vly.ai AI app builder. v0, illustrative — endpoints, paths,
    and shapes may change before general availability. See the API Reference
    introduction for status.
  contact:
    name: vly.ai support
    email: support@vly.ai
    url: https://docs.vly.ai/api-reference/introduction
  license:
    name: vly.ai Terms
    url: https://vly.ai/terms
servers:
  - url: https://api.vly.ai
    description: Production
  - url: https://api.staging.vly.ai
    description: Staging
security:
  - bearerAuth: []
tags:
  - name: Projects
    description: Create, list, update, and delete vly projects.
  - name: Deployments
    description: Trigger and inspect deployments.
  - name: Agents
    description: Trigger an AI agent run on a project.
  - name: Files
    description: Upload assets to a project.
  - name: Billing
    description: Inspect plan usage and credits.
  - name: Webhooks
    description: Send and verify webhook events.
paths:
  /v1/webhooks/test:
    post:
      tags:
        - Webhooks
      summary: Send a test webhook
      description: >-
        Sends a sample event to a configured webhook endpoint, useful for
        verifying signature handling.
      operationId: testWebhook
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - endpointId
                - event
              properties:
                endpointId:
                  type: string
                event:
                  type: string
                  enum:
                    - project.created
                    - deployment.succeeded
                    - deployment.failed
                    - agent.completed
      responses:
        '204':
          description: No content — webhook dispatched.
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: vly_live_...
      description: Workspace-scoped API key. Generate from Workspace settings → API keys.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.