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

# Listar webhooks

> Lista webhooks da API key.

<RequestExample>
  ```bash cURL theme={null}
  curl -X GET 'https://api.goatpay.com.br/v1/webhooks/list' \
    -H 'X-API-Key: gp_live_SUA_CHAVE'
  ```
</RequestExample>

<ResponseExample>
  ```json Success theme={null}
  {
    "success": true,
    "message": "Webhooks listados com sucesso",
    "data": {
      "items": [{
        "id": "clx_webhook",
        "url": "https://api.suaempresa.com/webhooks/goatpay",
        "description": "ERP produção",
        "events": ["payment.paid", "transfer.completed"],
        "status": "ACTIVE",
        "createdAt": "2026-07-01T12:00:00.000Z"
      }]
    },
    "requestId": "req_abc"
  }
  ```
</ResponseExample>


## OpenAPI

````yaml GET /webhooks/list
openapi: 3.1.0
info:
  title: GoatPay API
  description: >
    API pública merchant da GoatPay. Autenticação via header `X-API-Key:
    gp_live_...`.

    Respostas de sucesso usam o envelope `{ success, message, data, requestId
    }`.

    Campos internos (`accountId`, `metadata`, histórico de entregas de webhook,
    etc.) não são expostos.

    `providerTransactionId` aparece como `referenceId`; `providerInfractionId`
    como `infractionId`.

    Rate limit global: 100 requisições por minuto por API key (HTTP 429). Sem
    chave, limite por IP.
  version: 1.0.0
servers:
  - url: https://api.goatpay.com.br/v1
    description: Produção
security:
  - apiKeyAuth: []
tags:
  - name: pix
    description: >-
      Cobranças PIX (receber), reembolsos de depósito recebido e transferências
      PIX (enviar). Alias legado em payouts/* para envios.
  - name: transfer-internal
    description: Transferências entre contas GoatPay
  - name: transfer-scheduled
    description: Transferências programadas (agendar, repetir ou por saldo)
  - name: crypto
    description: Depósitos e transferências em criptomoeda
  - name: billings
    description: >-
      Cobranças avulsas (pagamento único) — boleto, cartão ou PIX na Conta
      Padrão (PF ou PJ)
  - name: subscriptions
    description: >-
      Assinaturas recorrentes com ciclo fixo — boleto, cartão ou PIX na Conta
      Padrão (PF ou PJ)
  - name: account
    description: Saldo e extrato
  - name: subaccount
    description: Subcontas merchant (carteiras lógicas sob a conta principal)
  - name: meds
    description: Disputas MED
  - name: webhooks
    description: Endpoints de webhook de saída
  - name: payouts
    description: Alias de transfer-pix para saques PIX
  - name: customers
    description: Clientes da loja (CRM)
  - name: products
    description: Produtos e entregas digitais
  - name: coupons
    description: Cupons de desconto para links
  - name: payment-links
    description: Links de pagamento e checkout hospedado
paths:
  /webhooks/list:
    get:
      tags:
        - webhooks
      summary: Listar webhooks
      operationId: listWebhooks
      responses:
        '200':
          $ref: '#/components/responses/WebhookListSuccess'
components:
  responses:
    WebhookListSuccess:
      description: Lista de endpoints de webhook (sem histórico de entregas).
      content:
        application/json:
          schema:
            type: object
            required:
              - success
              - message
              - data
            properties:
              success:
                type: boolean
              message:
                type: string
              data:
                $ref: '#/components/schemas/PublicWebhookListData'
              requestId:
                type: string
          examples:
            list:
              summary: Dois endpoints
              value:
                success: true
                message: Webhooks listados com sucesso
                data:
                  items:
                    - id: clx_webhook_a
                      url: https://api.exemplo.com/hooks/a
                      description: Produção
                      events:
                        - payment.paid
                      status: ACTIVE
                      createdAt: '2026-06-01T10:00:00.000Z'
                    - id: clx_webhook_b
                      url: https://api.exemplo.com/hooks/b
                      description: Homologação
                      events:
                        - webhook.test
                      status: DISABLED
                      createdAt: '2026-05-20T08:00:00.000Z'
                requestId: req_wh002
  schemas:
    PublicWebhookListData:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/PublicWebhookEndpoint'
    PublicWebhookEndpoint:
      type: object
      properties:
        id:
          type: string
        url:
          type: string
          format: uri
        description:
          type: string
        events:
          type: array
          items:
            type: string
        status:
          type: string
          enum:
            - ACTIVE
            - DISABLED
            - PENDING_SECRET
        createdAt:
          type: string
          format: date-time
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Chave `gp_live_...` criada em Integrações → Chaves de API no dashboard.

````