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

# Register Webhook

> Register endpoints for quotes, booking confirmations, status, and document events

Register endpoints for quotes, booking confirmations, status, and document events.

<ParamField status="201" type="WebhookRegistrationResponse">
  <ParamField name="webhookId" type="string">
    Webhook ID
  </ParamField>

  <ParamField name="url" type="string">
    Registered URL
  </ParamField>

  <ParamField name="events" type="array">
    Subscribed events
  </ParamField>

  <ParamField name="createdAt" type="string" format="date-time">
    Registration timestamp
  </ParamField>
</ParamField>


## OpenAPI

````yaml POST /api/webhooks
openapi: 3.0.3
info:
  title: Mock API
  version: 1.0.0
  description: >-
    Mock OpenAPI spec for QR API Service. All endpoints require API key
    authentication via 'Authorization: Bearer <token>' or 'x-api-key: <token>'
    headers.
servers:
  - url: https://1a557de0-701c-477d-bedd-433520441dae.mock.pstmn.io
    description: Production server
security:
  - ApiKeyAuth: []
  - ApiKeyHeader: []
tags:
  - name: auth-v1
    description: Authentication and user management
  - name: reference-data-v1
    description: Reference data and master data
  - name: flights-v1
    description: Flight schedules and capacity
  - name: quotes-v1
    description: Quotation and pricing
  - name: awb-stock-v1
    description: AWB Stock Management
  - name: bookings-v1
    description: Booking management
  - name: shipments-v1
    description: Shipment documents and tracking
  - name: compliance-v1
    description: Compliance and safety declarations
  - name: operations-v1
    description: Operational events and manifests
  - name: webhooks-v1
    description: Webhook management
  - name: admin-v1
    description: Administrative and audit functions
  - name: qr-exp-cgo-ext-availability-v1
    description: Legacy availability service
  - name: qr-exp-cgo-ext-booking-v1
    description: Legacy booking service
  - name: qr-exp-cgo-ext-flight-schedules-v1
    description: Legacy flight schedules service
  - name: qr-exp-cgo-shipments-v1
    description: Legacy shipments service
  - name: qr-exp-cgo-stock-v1
    description: Legacy stock service
  - name: qr-exp-cgo-tables-v1
    description: Legacy table data service
paths:
  /api/webhooks:
    post:
      tags:
        - webhooks-v1
      summary: Register webhook
      description: >-
        Register endpoints for quotes, booking confirmations, status, and
        document events
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebhookRegistrationRequest'
      responses:
        '201':
          description: Webhook registered
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookRegistrationResponse'
components:
  schemas:
    WebhookRegistrationRequest:
      type: object
      properties:
        url:
          type: string
          format: uri
          example: https://api.example.com/webhooks
        events:
          type: array
          items:
            type: string
            enum:
              - quote.created
              - quote.priced
              - booking.confirmed
              - shipment.status
              - document.uploaded
          example:
            - quote.created
            - booking.confirmed
        secret:
          type: string
          example: webhook-secret-123
      required:
        - url
        - events
    WebhookRegistrationResponse:
      type: object
      properties:
        webhookId:
          type: string
          example: webhook-123
        url:
          type: string
          example: https://api.example.com/webhooks
        events:
          type: array
          items:
            type: string
          example:
            - quote.created
            - booking.confirmed
        createdAt:
          type: string
          format: date-time
          example: '2024-01-01T10:00:00Z'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
    ApiKeyHeader:
      type: apiKey
      in: header
      name: x-api-key

````