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

# List Webhook Events Public

> List all available webhook events.

**Required scope:** `read`

Returns a list of events that can be subscribed to:
- `proposal.created` - When a new proposal is created
- `proposal.updated` - When a proposal is updated
- `proposal.status_changed` - When proposal status changes
- `proposal.shared` - When a proposal is shared
- `proposal.viewed` - When a shared proposal is viewed
- `proposal.response_received` - When client responds to a proposal
- `proposal.deleted` - When a proposal is deleted



## OpenAPI

````yaml /openapi/openapi-external.json get /webhooks/events
openapi: 3.1.0
info:
  title: Quikly.ai External API
  version: 1.0.0
  description: >-
    REST API for external integrations with Quikly.ai. Authenticate using an API
    key passed in the X-API-Key header. Use these endpoints from n8n, Zapier,
    custom scripts, or any HTTP client.
servers: []
security:
  - ApiKeyAuth: []
tags:
  - name: Proposals
    description: Create, read, update, and manage client proposals.
  - name: Profile
    description: Read and update the authenticated user's profile.
  - name: Templates
    description: Manage reusable proposal templates.
  - name: AI Services
    description: >-
      AI-powered analysis: rate recommendations, brief analysis,
      differentiators.
  - name: Public API
  - name: Usage
    description: Query API usage and quota information.
  - name: Webhooks
    description: Manage webhook subscriptions for real-time events.
  - name: Agent
    description: Interact with the AI agent for automated workflows.
  - name: Lead Sessions
    description: Track and manage lead capture sessions.
paths:
  /webhooks/events:
    get:
      tags:
        - Webhooks
      summary: List Webhook Events Public
      description: |-
        List all available webhook events.

        **Required scope:** `read`

        Returns a list of events that can be subscribed to:
        - `proposal.created` - When a new proposal is created
        - `proposal.updated` - When a proposal is updated
        - `proposal.status_changed` - When proposal status changes
        - `proposal.shared` - When a proposal is shared
        - `proposal.viewed` - When a shared proposal is viewed
        - `proposal.response_received` - When client responds to a proposal
        - `proposal.deleted` - When a proposal is deleted
      operationId: list_webhook_events_public_api_external_v1_webhooks_events_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookEventsResponse'
      security:
        - APIKeyHeader: []
components:
  schemas:
    WebhookEventsResponse:
      properties:
        events:
          items:
            type: object
          type: array
          title: Events
      type: object
      required:
        - events
      title: WebhookEventsResponse
      description: Schema for available webhook events.
      example:
        events:
          - description: Fired when a new proposal is created
            name: proposal.created
          - description: Fired when proposal status changes
            name: proposal.status_changed
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key obtained from Quikly.ai Settings → API Keys.
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key

````