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

# Listar webhooks

> Retorna todos os webhooks da sua loja com suporte a paginação e busca.

**Alternativa**: Você também pode visualizar e gerenciar seus webhooks pelo [Dashboard da AbacatePay](https://app.abacatepay.com/webhooks).


<Card horizontal>
  Requer a permissão `WEBHOOK:READ`.
</Card>


## OpenAPI

````yaml GET /webhooks/list
openapi: 3.1.0
info:
  title: API AbacatePay
  description: API para gerenciamento de cobranças e pagamentos usando o AbacatePay.
  version: 1.0.0
servers:
  - url: https://api.abacatepay.com/v2
    description: Único servidor para os ambientes de produção e sandbox.
security: []
paths:
  /webhooks/list:
    get:
      summary: Listar webhooks
      description: >
        Retorna todos os webhooks da sua loja com suporte a paginação e busca.


        **Alternativa**: Você também pode visualizar e gerenciar seus webhooks
        pelo [Dashboard da AbacatePay](https://app.abacatepay.com/webhooks).
      parameters:
        - name: search
          in: query
          description: Busca por nome, ID ou endpoint do webhook
          required: false
          schema:
            type: string
            example: pagamentos
        - name: after
          in: query
          description: Cursor para buscar itens após este ponto
          required: false
          schema:
            type: string
        - name: before
          in: query
          description: Cursor para buscar itens antes deste ponto
          required: false
          schema:
            type: string
        - name: limit
          in: query
          description: Quantidade de itens por página (1-100)
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 100
            example: 100
        - name: id
          in: query
          description: Filtrar por identificador único do webhook
          required: false
          schema:
            type: string
            example: webh_abc123xyz
      responses:
        '200':
          description: Lista de webhooks retornada com sucesso.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    description: Lista de webhooks.
                    items:
                      $ref: '#/components/schemas/WebhookResponse'
                  success:
                    $ref: '#/components/schemas/Success'
                  error:
                    type: string
                    nullable: true
                    example: null
                  pagination:
                    $ref: '#/components/schemas/PaginationCursor'
        '401':
          description: Não autorizado. Falha na autenticação.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: >-
                      Mensagem de erro descrevendo o motivo da falha na
                      autenticação.
                    example: Token de autenticação inválido ou ausente.
      security:
        - bearerAuth: []
components:
  schemas:
    WebhookResponse:
      type: object
      description: Os dados do webhook.
      required:
        - id
        - name
        - endpoint
        - events
        - devMode
        - v2
        - createdAt
        - updatedAt
      additionalProperties: false
      properties:
        id:
          type: string
          description: Identificador único do webhook
          example: webh_abc123xyz
        name:
          type: string
          description: Nome identificador do webhook
          example: Webhook de Pagamentos
        endpoint:
          type: string
          description: URL HTTPS que recebe as notificações de eventos
          example: https://meusite.com/webhooks/abacatepay
        events:
          type: array
          description: Lista de eventos subscritos
          items:
            type: string
          example:
            - checkout.completed
            - subscription.renewed
        devMode:
          type: boolean
          description: Indica se o webhook foi criado em ambiente de testes
          example: false
        v2:
          type: boolean
          description: Indica se o webhook usa o formato de payload v2
          example: true
        createdAt:
          type: string
          format: date-time
          description: Data de criação do webhook
          example: '2025-01-01T00:00:00.000Z'
        updatedAt:
          type: string
          format: date-time
          description: Data da última atualização do webhook
          example: '2025-01-01T00:00:00.000Z'
    Success:
      type: boolean
      description: Se a requisição obteve sucesso ou não.
      example: true
    PaginationCursor:
      type: object
      description: Informações de paginação baseada em cursor.
      required:
        - hasMore
        - next
        - before
      additionalProperties: false
      properties:
        hasMore:
          type: boolean
          description: Indica se existe mais itens para carregar.
        next:
          type: string
          nullable: true
          description: Cursor para próxima página (usar em after).
        before:
          type: string
          nullable: true
          description: Cursor para página anterior (usar em before).
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Todas as requisições devem incluir sua chave de API no header
        Authorization usando o formato `Bearer <abacatepay-api-key>`. Sem esse
        header a requisição será rejeitada.


        Saiba mais sobre como criar e usar chaves de API na [documentação de
        autenticação](/pages/authentication).

````