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

# List webhooks

> Lists the webhooks visible to the calling key. A tenant key sees ALL of the tenant's webhooks; with number context (a number-scoped key or the x-whatsapp-number-id header) it sees STRICTLY the webhooks subscribed to that number (tenant-wide webhooks with no subscription are NOT returned). The signing secret is NEVER returned. A per-number OAuth grant must send x-whatsapp-number-id (otherwise 400 NUMBER_REQUIRED).



## OpenAPI

````yaml openapi.json GET /v1/webhooks
openapi: 3.1.0
info:
  title: Pilot Status API
  version: 1.0.0
  license:
    name: Pilot Status Terms of Service
    url: https://pilotstatus.com.br/terms
  description: >-
    Public REST API for Pilot Status. Authenticate with the `x-api-key: ps_...`
    header (or `x-api-key-id`). Base URL: https://pilotstatus.com.br
servers:
  - url: https://pilotstatus.com.br
security:
  - apiKey: []
  - apiKeyId: []
paths:
  /v1/webhooks:
    get:
      tags:
        - Webhooks
      summary: List webhooks
      description: >-
        Lists the webhooks visible to the calling key. A tenant key sees ALL of
        the tenant's webhooks; with number context (a number-scoped key or the
        x-whatsapp-number-id header) it sees STRICTLY the webhooks subscribed to
        that number (tenant-wide webhooks with no subscription are NOT
        returned). The signing secret is NEVER returned. A per-number OAuth
        grant must send x-whatsapp-number-id (otherwise 400 NUMBER_REQUIRED).
      operationId: get_webhooks
      parameters:
        - name: x-whatsapp-number-id
          in: header
          required: false
          description: Scopes to a single number (required for per-number OAuth grants).
          schema:
            type: string
          example: num_01HZX...
      responses:
        '200':
          description: List webhooks
          content:
            application/json:
              example:
                - id: wh_01HZX...
                  tenantId: tenant_01HZX...
                  name: n8n
                  url: https://hooks.acme.com/whatsapp
                  environment: LIVE
                  active: true
                  events:
                    - message.received
                    - message.delivered
                  apiKeys:
                    - id: key_01HZX...
                      name: Default
                  lastTriggered: '2026-06-28T09:59:00.000Z'
                  whatsappNumberIds:
                    - num_01HZX...
                  whatsappInstanceIds: []
                  createdAt: '2026-06-01T11:59:00.000Z'
                  updatedAt: '2026-06-01T12:00:00.000Z'
        '401':
          description: Missing or invalid `x-api-key` / `x-api-key-id` header
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Unauthorized
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Too many requests
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: Your ps_ API key
    apiKeyId:
      type: apiKey
      in: header
      name: x-api-key-id
      description: API key id (alternative to x-api-key)

````