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

# Create webhook endpoint



## OpenAPI

````yaml /api-reference/openapi.json post /v1/webhooks
openapi: 3.1.0
info:
  title: Veri API
  description: >-
    REST API for the Veri RL post-training platform. All requests require a
    Bearer API key (`vk_` prefix).
  license:
    name: ''
  version: 0.1.0
servers:
  - url: https://api.veri.studio
    description: Production
security: []
tags:
  - name: Training jobs
    description: Create, monitor, and manage training jobs.
  - name: Datasets
    description: Upload and connect training datasets.
  - name: Deployments
    description: Serve trained models and run inference.
  - name: Volumes
    description: Persistent file storage mounted into jobs.
  - name: Models
    description: Custom model registry deployments serve from.
  - name: Regions
    description: Discover available launch regions.
  - name: GPU
    description: Live GPU availability by provider and region.
  - name: Compatibility
    description: Advisory model and runtime compatibility guidance.
  - name: Code artifacts
    description: Upload custom training script bundles.
  - name: Billing
    description: Credit balance and transaction history.
  - name: API keys
    description: Create and revoke API keys.
  - name: Account
    description: The authenticated caller's identity.
  - name: SSH keys
    description: Manage SSH key pairs for compute access.
  - name: Settings
    description: Account-level integrations (Weights & Biases).
  - name: Metrics
    description: Prometheus metrics export for your own observability stack.
paths:
  /v1/webhooks:
    post:
      tags:
        - Webhooks
      summary: Create webhook endpoint
      operationId: create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateWebhookRequest'
        required: true
      responses:
        '200':
          description: >-
            The created endpoint. This is the ONLY response that includes the
            full signing secret.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookResponse'
        '400':
          description: >-
            Invalid URL (non-https, private/internal address) or unknown event
            type
      security:
        - bearerAuth: []
components:
  schemas:
    CreateWebhookRequest:
      type: object
      required:
        - url
      properties:
        url:
          type: string
          description: Publicly routable https receiver URL.
        description:
          type:
            - string
            - 'null'
        event_types:
          type:
            - array
            - 'null'
          items:
            type: string
          description: >-
            Event types to receive (e.g. ["deployment.serving",
            "job.completed"]).

            Omit or pass [] to subscribe to all events.
    WebhookResponse:
      type: object
      required:
        - object
        - id
        - url
        - secret
        - event_types
        - consecutive_failures
        - created_at
        - updated_at
      properties:
        object:
          type: string
        id:
          type: string
        url:
          type: string
        secret:
          type: string
          description: >-
            Full "whsec_..." signing secret on create ONLY; masked on every
            other

            read (use GET /v1/webhooks/{id}/secret to retrieve it again).
        description:
          type:
            - string
            - 'null'
        event_types:
          type: array
          items:
            type: string
          description: Empty = subscribed to all event types.
        disabled_at:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            Set when the endpoint is disabled (manually or automatically after
            50

            consecutive delivery failures). Disabled endpoints receive no
            events.
        consecutive_failures:
          type: integer
          format: int32
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: API key with the `vk_` prefix. Create one from the dashboard.

````