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

# Listar webhooks de saída

> Lista os webhooks de saída armazenados (enviados aos clientes). O parâmetro de query `flow_type` é obrigatório. Entradas em dead-letter são expostas de forma transparente com `status="DEAD_LETTER"`.



## OpenAPI

````yaml pt/openapi/v3-current/indirect-pix.yaml GET /v1/webhooks/outbound
openapi: 3.0.3
info:
  title: Plugin BR Pix Indireto - API Completa
  description: |
    API completa para o sistema brasileiro de pagamentos instantâneos Pix,
    incluindo operações de dicionário de chaves Pix, geração/decodificação de
    QR Code, transações e limites de transações.
  version: 1.7.6
servers:
  - url: https://plugin-pix-indirect.api.lerian.net
security:
  - bearerAuth: []
paths:
  /v1/webhooks/outbound:
    get:
      tags:
        - Webhooks API
      summary: Listar webhooks de saída
      description: >-
        Lista os webhooks de saída armazenados (enviados aos clientes). O
        parâmetro de query `flow_type` é obrigatório. Entradas em dead-letter
        são expostas de forma transparente com `status="DEAD_LETTER"`.
      parameters:
        - name: flow_type
          in: query
          description: >-
            Obrigatório. Tipo de fluxo de saída. Convertido para maiúsculas no
            servidor.
          schema:
            type: string
            enum:
              - DICT
              - PAYMENT
              - COLLECTION
              - PIX
              - TRANSFER
              - REFUND
              - RECURRING
        - name: entity_type
          in: query
          description: >-
            Filtrar por tipo de entidade interno. Exemplos: CLAIM, REFUND,
            INFRACTION_REPORT sob flow_type=DICT; CASHIN, CASHOUT sob
            flow_type=TRANSFER ou REFUND.
          schema:
            type: string
        - name: entity_id
          in: query
          description: Filtrar por id de entidade no formato UUID
          schema:
            type: string
        - name: status
          in: query
          description: >-
            Filtrar por status. DEAD_LETTER é um valor virtual, exclusivo da
            API, que expõe webhooks em dead-letter.
          schema:
            type: string
            enum:
              - PENDING
              - PROCESSING
              - SENT
              - FAILED
              - DEAD_LETTER
        - name: request_id
          in: query
          description: Filtrar pelo id da requisição de origem
          schema:
            type: string
        - name: created_after
          in: query
          description: Filtrar registros com created_at >= esta data/hora RFC3339
          schema:
            type: string
        - name: created_before
          in: query
          description: Filtrar registros com created_at <= esta data/hora RFC3339
          schema:
            type: string
        - $ref: '#/components/parameters/Limit'
        - $ref: '#/components/parameters/Page'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListOutboundWebhooksOutput'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorFormat'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorFormat'
      security:
        - bearerAuth: []
components:
  parameters:
    Limit:
      name: limit
      in: query
      description: Número máximo de itens por página.
      required: false
      example: 10
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 10
    Page:
      name: page
      in: query
      description: Número da página para paginação.
      required: false
      example: 1
      schema:
        type: integer
        minimum: 1
        default: 1
  schemas:
    ListOutboundWebhooksOutput:
      properties:
        items:
          items:
            $ref: '#/components/schemas/WebhookOutboundOutput'
          type: array
        limit:
          type: integer
          example: 20
        page:
          type: integer
          example: 1
        totalItems:
          type: integer
          example: 42
      type: object
    ErrorFormat:
      type: object
      description: A mensagem de erro da resposta.
      required:
        - code
        - title
        - message
      properties:
        code:
          type: string
          description: Um identificador único e estável para o erro.
        title:
          type: string
          description: Um breve resumo do problema.
        message:
          type: string
          description: Orientação detalhada para resolver o erro.
    WebhookOutboundOutput:
      properties:
        attemptCount:
          type: integer
          example: 0
        createdAt:
          example: '2026-05-21T12:00:00Z'
          format: date-time
          type: string
        deadLetter:
          description: >-
            Campos exclusivos de dead-letter. Preenchidos quando DeadLetter é
            true.
          example: false
          type: boolean
        deliveredAt:
          example: '2026-05-21T12:00:00Z'
          format: date-time
          type: string
        entityId:
          example: 019cf6ef-e418-7ced-80c0-7b9816faa798
          type: string
        entityType:
          example: DICT_ENTRY
          type: string
        errorMessage:
          example: timeout calling target URL
          type: string
        failedAt:
          example: '2026-05-21T12:00:00Z'
          format: date-time
          type: string
        failureReason:
          example: max_retries_exceeded
          type: string
        flowType:
          example: DICT
          type: string
        id:
          example: 019cf6ef-e418-7ced-80c0-7b9816faa798
          type: string
        lastAttemptAt:
          example: '2026-05-21T12:00:00Z'
          format: date-time
          type: string
        maxRetries:
          example: 3
          type: integer
        movedBy:
          example: system
          type: string
        nextRetryAt:
          example: '2026-05-21T12:00:00Z'
          format: date-time
          type: string
        payload:
          type: object
        requestId:
          example: 560d59b9-3c74-46f8-be67-fee895b8e89e
          type: string
        status:
          enum:
            - PENDING
            - PROCESSING
            - SENT
            - FAILED
            - DEAD_LETTER
          example: PENDING
          type: string
        targetUrl:
          example: https://client.example.com/webhooks
          type: string
        updatedAt:
          example: '2026-05-21T12:00:00Z'
          format: date-time
          type: string
      type: object
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````