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

# Listar entregas de webhook

> Lista as tentativas de entrega de webhook da empresa autenticada, da mais recente para a mais antiga, com evento, situação e URL de destino. Filtre por `status=error` para achar de uma vez tudo que o seu servidor recusou e precisa ser reenviado.



## OpenAPI

````yaml /openapi.yaml get /v1/webhook-deliveries
openapi: 3.0.3
info:
  title: Ephra API
  description: >-
    API pública da Ephra: cobranças (PIX, cartão e boleto), transações, webhooks
    e a API do vendedor sobre catálogo, checkout, vendas, reembolsos,
    financeiro, crescimento e plataforma.


    **Limite de requisições.** 1000 requisições por minuto por IP de origem.
    Toda resposta traz `x-ratelimit-limit`, `x-ratelimit-remaining` e
    `x-ratelimit-reset` (segundos até a janela zerar); ao estourar o limite a
    resposta é `429` com `retry-after`.


    **Erros.** Toda falha responde o mesmo envelope: `{ "success": false,
    "message": "..." }`.
  version: 1.0.0
servers:
  - url: https://api.ephra.io
    description: Servidor de produção
security: []
tags:
  - name: Catálogo
    description: Produtos, ofertas, categorias e cupons — o que a empresa vende.
  - name: Checkout
    description: Checkouts, order bumps, upsells e links de pagamento.
  - name: Vendas
    description: Vendas, clientes, assinaturas e entregas já realizadas.
  - name: Reembolsos
    description: Pedidos de reembolso, contestações e o quiz de retenção.
  - name: Financeiro
    description: Saldo, saques, antecipações, taxas e extratos da empresa.
  - name: Crescimento
    description: Afiliados, coprodução, indicações, pixels e integrações de marketing.
  - name: Plataforma
    description: Conta, membros, chaves de API, webhooks e configurações gerais.
paths:
  /v1/webhook-deliveries:
    get:
      tags:
        - Plataforma
      summary: Listar entregas de webhook
      description: >-
        Lista as tentativas de entrega de webhook da empresa autenticada, da
        mais recente para a mais antiga, com evento, situação e URL de destino.
        Filtre por `status=error` para achar de uma vez tudo que o seu servidor
        recusou e precisa ser reenviado.
      operationId: listWebhookDeliveries
      parameters:
        - schema:
            type: integer
            minimum: 1
            default: 1
          in: query
          name: page
          required: false
          description: Página desejada, começando em 1.
        - schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 10
          in: query
          name: pageSize
          required: false
          description: Quantidade de itens por página (máximo 100).
        - schema:
            type: string
            enum:
              - pending
              - success
              - error
              - failed
              - suppressed
          in: query
          name: status
          required: false
          description: Filtra por situação da entrega.
        - schema:
            type: string
            enum:
              - transaction_created
              - transaction_paid
              - transaction_refunded
              - transaction_updated
              - transfer_completed
              - transfer_canceled
              - transfer_created
              - transfer_updated
              - infraction
              - cart_abandoned
              - sale_lost
              - card_declined
              - product_canceled
              - company_approved
              - product_approved
              - product_refused
              - withdrawal_requested
              - withdrawal_sent
              - transaction_reversal
              - release_access
              - vturb_paid
              - vk_metrics_purchase
              - refund_requested
          in: query
          name: event
          required: false
          description: Filtra por evento notificado.
      responses:
        '200':
          description: Página de entregas de webhook da empresa.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Sempre `true` em uma resposta bem-sucedida.
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: Identificador da entrega.
                        transactionId:
                          type: string
                          nullable: true
                          description: Venda que originou o evento, quando houver.
                        type:
                          type: string
                          enum:
                            - transaction
                            - transfer
                            - infraction
                          description: 'Origem do evento: venda, saque ou contestação.'
                        event:
                          type: string
                          enum:
                            - transaction_created
                            - transaction_paid
                            - transaction_refunded
                            - transaction_updated
                            - transfer_completed
                            - transfer_canceled
                            - transfer_created
                            - transfer_updated
                            - infraction
                            - cart_abandoned
                            - sale_lost
                            - card_declined
                            - product_canceled
                            - company_approved
                            - product_approved
                            - product_refused
                            - withdrawal_requested
                            - withdrawal_sent
                            - transaction_reversal
                            - release_access
                            - vturb_paid
                            - vk_metrics_purchase
                            - refund_requested
                          description: Evento notificado.
                        eventType:
                          type: string
                          description: >-
                            Rótulo do evento como enviado no corpo da
                            notificação.
                        status:
                          type: string
                          enum:
                            - pending
                            - success
                            - error
                            - failed
                            - suppressed
                          description: >-
                            Situação da entrega: pendente, entregue, com erro ou
                            suprimida.
                        url:
                          type: string
                          description: URL que recebeu (ou receberá) o POST.
                        retries:
                          type: integer
                          description: Quantidade de retentativas já feitas.
                        createdAt:
                          type: string
                          format: date-time
                          description: Momento em que o evento foi enfileirado.
                        updatedAt:
                          type: string
                          format: date-time
                          description: Momento da última tentativa.
                      required:
                        - id
                        - transactionId
                        - type
                        - event
                        - eventType
                        - status
                        - url
                        - retries
                        - createdAt
                        - updatedAt
                      additionalProperties: false
                  pagination:
                    type: object
                    properties:
                      page:
                        type: integer
                        description: Página devolvida.
                      pageSize:
                        type: integer
                        description: Itens por página pedidos.
                      total:
                        type: integer
                        description: Total de itens que satisfazem o filtro.
                      totalPages:
                        type: integer
                        description: Total de páginas disponíveis.
                    required:
                      - page
                      - pageSize
                      - total
                      - totalPages
                    additionalProperties: false
                required:
                  - success
                  - data
                  - pagination
                additionalProperties: false
                description: Página de entregas de webhook da empresa.
              example:
                success: true
                data:
                  - id: clx9f1m2p0004qz0a7h8i9j0k
                    transactionId: clx9e0k1n0002qz0a5f6g7h8i
                    type: transaction
                    event: transaction_paid
                    eventType: transaction.paid
                    status: error
                    url: https://erp.minhaloja.com.br/integracoes/ephra
                    retries: 3
                    createdAt: '2026-09-10T14:22:05.000Z'
                    updatedAt: '2026-09-10T14:38:41.000Z'
                pagination:
                  page: 1
                  pageSize: 10
                  total: 1
                  totalPages: 1
        '401':
          description: Token ausente, inválido, expirado ou de empresa bloqueada.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Sempre `false` em uma resposta de erro.
                  message:
                    type: string
                    description: Mensagem legível explicando a falha.
                required:
                  - success
                  - message
                additionalProperties: false
                description: Token ausente, inválido, expirado ou de empresa bloqueada.
              example:
                success: false
                message: Token inválido ou expirado
        '422':
          description: A requisição não passou na validação de schema.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Sempre `false` em uma resposta de erro.
                  message:
                    type: string
                    description: Mensagem legível explicando a falha.
                required:
                  - success
                  - message
                additionalProperties: false
                description: A requisição não passou na validação de schema.
              example:
                success: false
                message: 'name: Nome é obrigatório'
        '429':
          description: >-
            Requisições demais: o limite é de 1000 requisições por minuto por IP
            de origem. Espere o número de segundos do header `retry-after` e
            repita com recuo exponencial.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Sempre `false` em uma resposta de erro.
                  message:
                    type: string
                    description: Mensagem legível explicando a falha.
                required:
                  - success
                  - message
                additionalProperties: false
                description: >-
                  Requisições demais: o limite é de 1000 requisições por minuto
                  por IP de origem. Espere o número de segundos do header
                  `retry-after` e repita com recuo exponencial.
              example:
                success: false
                message: Muitas requisições. Tente novamente em breve.
          headers:
            retry-after:
              $ref: '#/components/headers/retry-after'
            x-ratelimit-limit:
              $ref: '#/components/headers/x-ratelimit-limit'
            x-ratelimit-remaining:
              $ref: '#/components/headers/x-ratelimit-remaining'
            x-ratelimit-reset:
              $ref: '#/components/headers/x-ratelimit-reset'
        '500':
          description: >-
            Falha interna ao processar a requisição. Repita; se persistir, abra
            chamado com o horário e a rota.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Sempre `false` em uma resposta de erro.
                  message:
                    type: string
                    description: Mensagem legível explicando a falha.
                required:
                  - success
                  - message
                additionalProperties: false
                description: >-
                  Falha interna ao processar a requisição. Repita; se persistir,
                  abra chamado com o horário e a rota.
              example:
                success: false
                message: Erro interno do servidor
      security:
        - bearerAuth: []
components:
  headers:
    retry-after:
      description: Segundos a esperar antes de repetir a requisição.
      schema:
        type: integer
    x-ratelimit-limit:
      description: Teto de requisições na janela (1000). Presente em toda resposta.
      schema:
        type: integer
    x-ratelimit-remaining:
      description: >-
        Quantas requisições ainda cabem na janela atual. Presente em toda
        resposta.
      schema:
        type: integer
    x-ratelimit-reset:
      description: Segundos até o contador da janela zerar. Presente em toda resposta.
      schema:
        type: integer
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````