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

# List webhooks

> Get webhooks for this number, most recent first.



## OpenAPI

````yaml /api/platform/v1/openapi-platform.yaml get /whatsapp/phone_numbers/{phone_number_id}/webhooks
openapi: 3.1.0
info:
  title: Kapso Platform API
  version: 0.2.0
  description: >
    Build WhatsApp messaging into your product. Manage customers, connect phone
    numbers, send broadcasts, and handle conversations.
servers:
  - url: https://api.kapso.ai/platform/v1
    description: Production
security:
  - ApiKeyAuth: []
tags:
  - name: Customers
    description: Manage customer accounts
  - name: Setup Links
    description: WhatsApp onboarding via embedded signup
  - name: Phone Numbers
    description: Connect and manage WhatsApp numbers
  - name: Webhooks
    description: Subscribe to WhatsApp events
  - name: Display Names
    description: Update WhatsApp business display names
  - name: Broadcasts
    description: |
      Send template messages at scale

      **Alpha**: This API is in alpha and subject to change
  - name: Conversations
    description: Manage conversation state
  - name: Media
    description: Upload media files for WhatsApp messaging
  - name: Users
    description: Manage project team members
  - name: Inbox Embeds
    description: Create and manage embeddable inbox access links
  - name: Webhook Deliveries
    description: View webhook delivery attempts and their status
  - name: External API Logs
    description: View logs of external API calls made by the project
  - name: Log Search
    description: Search Logs V2 events across API, Meta, workflow, and webhook sources
  - name: Provider Models
    description: List available AI provider models
  - name: WhatsApp Flows
    description: Build interactive WhatsApp Flows for surveys and forms
  - name: Contacts
    description: Manage WhatsApp contacts
paths:
  /whatsapp/phone_numbers/{phone_number_id}/webhooks:
    parameters:
      - name: phone_number_id
        in: path
        required: true
        schema:
          type: string
    get:
      tags:
        - Webhooks
      summary: List webhooks
      description: Get webhooks for this number, most recent first.
      operationId: listWhatsappPhoneNumberWebhooks
      parameters:
        - name: url_contains
          in: query
          description: Filter by URL substring
          schema:
            type: string
        - name: kind
          in: query
          description: Filter by webhook kind
          schema:
            type: string
            enum:
              - kapso
              - meta
        - name: active
          in: query
          description: Filter by active status
          schema:
            type: boolean
        - name: created_after
          in: query
          schema:
            type: string
            format: date-time
        - name: created_before
          in: query
          schema:
            type: string
            format: date-time
        - name: per_page
          in: query
          schema:
            type: integer
            minimum: 1
        - name: page
          in: query
          schema:
            type: integer
            minimum: 1
      responses:
        '200':
          description: OK
          headers:
            X-Total:
              schema:
                type: integer
            X-Total-Pages:
              schema:
                type: integer
            X-Per-Page:
              schema:
                type: integer
            X-Page:
              schema:
                type: integer
            Link:
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WhatsappWebhookListResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '404':
          $ref: '#/components/responses/NotFoundError'
components:
  schemas:
    WhatsappWebhookListResponse:
      type: object
      required:
        - data
        - meta
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/WhatsappWebhook'
        meta:
          $ref: '#/components/schemas/PaginationMeta'
    WhatsappWebhook:
      type: object
      required:
        - id
        - url
        - kind
        - events
        - active
        - created_at
        - updated_at
        - project_id
      properties:
        id:
          type: string
          format: uuid
        url:
          type: string
          format: uri
          description: Webhook delivery endpoint
        kind:
          type: string
          enum:
            - kapso
            - meta
          default: kapso
          description: >-
            Webhook type - 'kapso' for event-based webhooks, 'meta' for raw Meta
            payload forwarding
        events:
          type: array
          description: >-
            Event subscriptions (required for 'kapso' webhooks, empty for
            'meta')
          items:
            type: string
        active:
          type: boolean
          description: Pause deliveries without deleting
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        project_id:
          type: string
          format: uuid
        phone_number_id:
          type:
            - string
            - 'null'
          description: Meta phone number ID
        secret_key:
          type:
            - string
            - 'null'
          description: Secret for signing requests
        headers:
          type:
            - object
            - 'null'
          additionalProperties: true
          description: Custom request headers
        buffer_enabled:
          type:
            - boolean
            - 'null'
          description: Batch messages before delivery
        buffer_window_seconds:
          type:
            - integer
            - 'null'
          description: Seconds to wait before sending batch
        max_buffer_size:
          type:
            - integer
            - 'null'
          description: Max messages per batch
        buffer_events:
          type: array
          description: Events to buffer
          items:
            type: string
        inactivity_minutes:
          type:
            - integer
            - 'null'
          description: Trigger inactivity event after N minutes
        payload_version:
          type:
            - string
            - 'null'
          description: Webhook payload format version (defaults to 'v2')
    PaginationMeta:
      type: object
      required:
        - page
        - per_page
        - total_pages
        - total_count
      properties:
        page:
          type: integer
          minimum: 1
        per_page:
          type: integer
          minimum: 1
        total_pages:
          type: integer
          minimum: 0
        total_count:
          type: integer
          minimum: 0
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: string
  responses:
    UnauthorizedError:
      description: Missing or invalid API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    NotFoundError:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key

````