> ## 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.

# Listar webhooks

> Lista os webhooks visíveis para a key chamadora. Uma key de tenant vê TODOS os webhooks do tenant; com contexto de número (key escopada a número ou cabeçalho x-whatsapp-number-id) vê ESTRITAMENTE os webhooks inscritos naquele número (webhooks gerais do tenant sem assinatura NÃO aparecem). O segredo de assinatura NUNCA é retornado. Uma concessão OAuth por número precisa enviar x-whatsapp-number-id (senão 400 NUMBER_REQUIRED).



## OpenAPI

````yaml openapi.pt.json GET /v1/webhooks
openapi: 3.1.0
info:
  title: API Pilot Status
  version: 1.0.0
  license:
    name: Pilot Status Terms of Service
    url: https://pilotstatus.com.br/terms
  description: >-
    API REST pública do Pilot Status. Autentique com o header `x-api-key:
    ps_...` (ou `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: Listar webhooks
      description: >-
        Lista os webhooks visíveis para a key chamadora. Uma key de tenant vê
        TODOS os webhooks do tenant; com contexto de número (key escopada a
        número ou cabeçalho x-whatsapp-number-id) vê ESTRITAMENTE os webhooks
        inscritos naquele número (webhooks gerais do tenant sem assinatura NÃO
        aparecem). O segredo de assinatura NUNCA é retornado. Uma concessão
        OAuth por número precisa enviar x-whatsapp-number-id (senão 400
        NUMBER_REQUIRED).
      operationId: get_webhooks
      parameters:
        - name: x-whatsapp-number-id
          in: header
          required: false
          description: >-
            Restringe ao contexto de um número (obrigatório em concessões OAuth
            por número).
          schema:
            type: string
          example: num_01HZX...
      responses:
        '200':
          description: Listar 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: Header `x-api-key` / `x-api-key-id` ausente ou inválido
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Unauthorized
        '429':
          description: Limite de taxa excedido
          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: Sua chave de API ps_
    apiKeyId:
      type: apiKey
      in: header
      name: x-api-key-id
      description: Id da chave de API (alternativa ao x-api-key)

````